<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow-IPC: transport/native_socket_stream.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow-IPC<span id="projectnumber">&#160;1.0.2</span>
   </div>
   <div id="projectbrief">Flow-IPC project: Full implementation reference.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_0c017496b493ff066fbbe686970307ba.html">transport</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle"><div class="title">native_socket_stream.hpp</div></div>
</div><!--header-->
<div class="contents">
<a href="native__socket__stream_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/* Flow-IPC: Core</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment"> * Copyright 2023 Akamai Technologies, Inc.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> *</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> * Licensed under the Apache License, Version 2.0 (the</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> * &quot;License&quot;); you may not use this file except in</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment"> * compliance with the License.  You may obtain a copy</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment"> * of the License at</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment"> *</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment"> *   https://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment"> *</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment"> * Unless required by applicable law or agreed to in</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment"> * writing, software distributed under the License is</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment"> * distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment"> * CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment"> * See the License for the specific language governing</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="comment"> * permissions and limitations under the License. */</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment"></span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="comment">/// @file</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="comment"></span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="preprocessor">#include &quot;<a class="code" href="transport__fwd_8hpp.html">ipc/transport/transport_fwd.hpp</a>&quot;</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="preprocessor">#include &quot;<a class="code" href="shared__name__fwd_8hpp.html">ipc/util/shared_name_fwd.hpp</a>&quot;</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span><span class="preprocessor">#include &quot;<a class="code" href="process__credentials_8hpp.html">ipc/util/process_credentials.hpp</a>&quot;</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span><span class="preprocessor">#include &quot;<a class="code" href="native__handle_8hpp.html">ipc/util/native_handle.hpp</a>&quot;</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span><span class="preprocessor">#include &lt;flow/log/log.hpp&gt;</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span><span class="preprocessor">#include &lt;flow/async/util.hpp&gt;</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span><span class="preprocessor">#include &lt;experimental/propagate_const&gt;</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span> </div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceipc_1_1transport.html">ipc::transport</a></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span>{</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span> </div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span><span class="comment">// Types.</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span><span class="comment"></span> </div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span><span class="comment">/**</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span><span class="comment"> * Implements both Native_handle_sender and Native_handle_receiver concepts by using a stream-oriented Unix domain</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span><span class="comment"> * socket, allowing high-performance but non-zero-copy transmission of discrete messages, each containing a native</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span><span class="comment"> * handle, a binary blob, or both.  This is a low-level (core) transport mechanism; higher-level (structured)</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span><span class="comment"> * transport mechanisms may use Native_socket_stream to enable their work.  Native_socket_stream, as of this writing,</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span><span class="comment"> * is unique in that it is able to transmit not only blobs but also native handles.</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span><span class="comment"> *</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span><span class="comment"> * @see sync_io::Native_socket_stream and util::sync_io doc headers.  The latter describes a general pattern which</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span><span class="comment"> *      the former implements.  In general we recommend you use a `*this` rather than a sync_io::Native_socket_stream --</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span><span class="comment"> *      but you may have particular needs (summarized in util::sync_io doc header) that would make you decide</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span><span class="comment"> *      otherwise.</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span><span class="comment"> *</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span><span class="comment"> * ### Quick note on naming ###</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span><span class="comment"> * It appears somewhat inconsistent to name it `Native_socket_stream[_acceptor]`</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span><span class="comment"> * and not `Native_handle_stream[_acceptor]`, given the implemented concept names `Native_handle_*er` and</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span><span class="comment"> * a key payload type being `Native_handle`.  It&#39;s subjective and a matter of aesthetics even, of course,</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span><span class="comment"> * but the reasoning is: It briefly conveys (or at least suggests) that the underlying transport</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span><span class="comment"> * is the Unix domain *socket* (*stream*-oriented at that); while also suggesting that *native* handles</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span><span class="comment"> * are transmissible over it (and it in fact is unique in that capability by the way).  Perhaps</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span><span class="comment"> * something like `Native_handle_socket_stream[_acceptor]` would&#39;ve been more accurate, but brevity is a virtue.</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span><span class="comment"> *</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span><span class="comment"> * @note The same reasoning applies for Socket_stream_channel and Socket_stream_channel_of_blobs with the</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span><span class="comment"> *       `native_` part being left out for orthogonal aesthetic reasons.</span></div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span><span class="comment"> *</span></div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span><span class="comment"> * ### Blob_sender and Blob_receiver concept compatibility ###</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span><span class="comment"> * Native_socket_stream also implements the Blob_sender and Blob_receiver concepts.  To wit:</span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span><span class="comment"> * You must choose whether you shall use this as a `Blob_sender/receiver` or `Native_handle_sender/receiver`,</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span><span class="comment"> * and conversely the other side must do the same in matched fashion.  Doing otherwise leads to undefined behavior.</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span><span class="comment"> * To use the latter concept pair simply use send_native_handle() and async_receive_native_handle() and never</span></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span><span class="comment"> * send_blob() or async_receive_blob().  To use the former concept pair simply do the reverse.</span></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span><span class="comment"> * On the other side do the matched thing.  All the other methods/dtor are the same regardless of concept pair chosen.</span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span><span class="comment"> *</span></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span><span class="comment"> * How does this work?  Trivially: consider, say, send_native_handle() which can send a native handle, or none;</span></div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span><span class="comment"> * and a blob, or none (but at least 1 of the 2).  send_blob() can only take a blob (which must be present) and</span></div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span><span class="comment"> * internally will simply act as send_native_handle() with a null handle.  Conversely async_receive_native_handle()</span></div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span><span class="comment"> * receives a handle (or none) and blob (or none); so async_receive_blob() will receive only a blob.  The only added</span></div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno">   70</span><span class="comment"> * behaviors in `Blob_sender/receiver` &quot;mode&quot;:</span></div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span><span class="comment"> *   - send_blob() requires a blob of size 1+.  (send_native_handle() allows an empty meta-blob; i.e., no blob.)</span></div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span><span class="comment"> *   - async_receive_blob() will emit an error if a payload arrives with a native handle in it:</span></div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span><span class="comment"> *     error::Code::S_BLOB_RECEIVER_GOT_NON_BLOB.  This would only occur if the other side were using the mismatched</span></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span><span class="comment"> *     API.</span></div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span><span class="comment"> *</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span><span class="comment"> * Further discussion ignores the degraded `Blob_*` concepts, as they are a trivial degenerate case of</span></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span><span class="comment"> * `Native_handle_*`.</span></div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span><span class="comment"> *</span></div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno">   79</span><span class="comment"> * @see other, dedicated Blob_sender and Blob_receiver impls namely, at least, the persistent-MQ-based</span></div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno">   80</span><span class="comment"> *      Blob_stream_mq_sender and Blob_stream_mq_receiver.  They may appeal due to potentially better performance</span></div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno">   81</span><span class="comment"> *      and/or a creation/addressing scheme that is more appealing, depending.</span></div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span><span class="comment"> *</span></div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span><span class="comment"> * ### Informal comparison to other core transport mechanisms ###</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno">   84</span><span class="comment"> * Firstly, as noted, it is currently unique in that it can transmit native handles.  The rest of the discussion</span></div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno">   85</span><span class="comment"> * here is about transmitting blobs (called meta-blobs, meaning they accompany native handles).</span></div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno">   86</span><span class="comment"> *</span></div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno">   87</span><span class="comment"> * It is intended for transmission of relatively short messages -- rough guidance</span></div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno">   88</span><span class="comment"> * being for max length being in the 10s-of-KiB range.  With a modern Linux kernel on server hardware from about 2014</span></div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno">   89</span><span class="comment"> * to 2020, our performance tests show that its raw speed for messages of aforementioned size is comparable to</span></div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span><span class="comment"> * zero-copy mechanisms based on POSIX message queues and Boost SHM-based message queues.  Technically we found it</span></div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno">   91</span><span class="comment"> * to be somewhat faster than the latter and somewhat slower than the former.  However, for best perf, it is recommended</span></div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span><span class="comment"> * to send handles to SHM areas containing arbitrarily long structured messages (such as ones [de]serialized using</span></div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno">   93</span><span class="comment"> * zero-copy builders: capnp and the like).  This further reduces the importance of relative perf compared to</span></div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno">   94</span><span class="comment"> * other low-level transports (which, as noted, is pretty close regardless -- though this is bound to stop being true</span></div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span><span class="comment"> * for much longer messages, if the send-SHM-handles technique were to *not* be used).</span></div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno">   96</span><span class="comment"> *</span></div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno">   97</span><span class="comment"> * ### Cleanup ###</span></div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno">   98</span><span class="comment"> * Some core transports rely on SHM or SHM-style semantics, wherein the transport has kernel persistence, meaning</span></div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno">   99</span><span class="comment"> * some or all processes exiting does not free the resources involved.  For those transports special measures must</span></div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno">  100</span><span class="comment"> * be taken to ensure cleanup after both relevant processes die or no longer use a transport instance.  This is not the</span></div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno">  101</span><span class="comment"> * case for Native_socket_stream: When the underlying (hidden from user) Unix domain socket handle is closed by both</span></div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno">  102</span><span class="comment"> * sides, all resources are automatically cleaned up; and processes exiting always closes all such handles.</span></div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno">  103</span><span class="comment"> * These matters for all transports are hidden from the user as much as possible, but these internal facts are still</span></div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno">  104</span><span class="comment"> * relevant knowledge for the reader/user.</span></div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno">  105</span><span class="comment"> *</span></div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno">  106</span><span class="comment"> * ### How to use ###</span></div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno">  107</span><span class="comment"> * Generally, this class&#39;s behavior is dictated by the 2 main concepts it implements: Native_handle_sender and</span></div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno">  108</span><span class="comment"> * Native_handle_receiver.  Though internally a single mechanism is used for both (incoming and outgoing) *pipes*</span></div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno">  109</span><span class="comment"> * (a term I use generically, not meaning &quot;Unix FIFOs&quot;), the two pipes are mostly decoupled.  Bottom line:</span></div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno">  110</span><span class="comment"> * Behavior is dictated by the 2 concepts, so please see their respective doc headers first.  Next, see the doc</span></div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno">  111</span><span class="comment"> * headers of the main concrete APIs which discuss any behaviors relevant to Native_socket_stream specifically:</span></div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno">  112</span><span class="comment"> *   - dtor;</span></div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno">  113</span><span class="comment"> *   - send_native_handle() (or send_blob()), `*end_sending()`, auto_ping();</span></div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno">  114</span><span class="comment"> *   - async_receive_native_handle() (or async_receive_blob()), idle_timer_run();</span></div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno">  115</span><span class="comment"> *   - send_meta_blob_max_size() (or send_blob_max_size());</span></div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno">  116</span><span class="comment"> *   - receive_meta_blob_max_size() (or receive_blob_max_size());</span></div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno">  117</span><span class="comment"> *   - default ctor;</span></div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno">  118</span><span class="comment"> *   - move ctor, move assignment.</span></div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno">  119</span><span class="comment"> *</span></div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno">  120</span><span class="comment"> * There is also:</span></div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno">  121</span><span class="comment"> *   - remote_peer_process_credentials() which is specific to Native_socket_stream and not those concepts.</span></div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno">  122</span><span class="comment"> *</span></div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno">  123</span><span class="comment"> * That above list (in?)conspicuously omits the initialization API.  So how does one create this connection</span></div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno">  124</span><span class="comment"> * and hence the two required `Native_socket_stream`s that are connected to each other (each in PEER state)?</span></div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno">  125</span><span class="comment"> *</span></div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno">  126</span><span class="comment"> * A Native_socket_stream object is always in one of 2 states:</span></div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno">  127</span><span class="comment"> *   - PEER.  Upon entering this state, the peer is connected (is an actual peer).  At this stage it exactly</span></div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno">  128</span><span class="comment"> *     implements the concepts Native_handle_sender, Native_handle_receiver, Blob_sender, Blob_receiver.</span></div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno">  129</span><span class="comment"> *     If the pipe is hosed (via an error or graceful-close), it remains in this PEER state (but cannot do anything</span></div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno">  130</span><span class="comment"> *     useful anymore).  It is not possible to exit PEER state.</span></div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno">  131</span><span class="comment"> *     - The only added behavior on top of the implemented concepts is remote_peer_process_credentials() (which is not</span></div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno">  132</span><span class="comment"> *       a concept API but logically only makes sense when already connected, i.e., in PEER state).</span></div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno">  133</span><span class="comment"> *   - NULL.  In this state, the object is doing nothing; neither connected nor connecting.</span></div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno">  134</span><span class="comment"> *</span></div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno">  135</span><span class="comment"> * Therefore, to be useful, one must somehow get to PEER state in which it implements the aforementioned concepts.</span></div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno">  136</span><span class="comment"> * How to do this?  Answer: There are 2* ways:</span></div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno">  137</span><span class="comment"> *   - Use Native_socket_stream_acceptor on the side you&#39;ve designated as the server for that connection or set of</span></div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno">  138</span><span class="comment"> *     connections.  This allows to wait for a connection and eventually, on success, moves the target</span></div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno">  139</span><span class="comment"> *     Native_socket_stream passed to Native_socket_stream_acceptor::async_accept() to PEER state.</span></div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno">  140</span><span class="comment"> *     - On the other side, use a Native_socket_stream in NULL state and invoke sync_connect() which will move</span></div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno">  141</span><span class="comment"> *       synchronously and non-blockingly to PEER state (mission accomplished).</span></div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno">  142</span><span class="comment"> *       If the connect fails (also synchronously, non-blockingly), it will go back to NULL state.</span></div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno">  143</span><span class="comment"> *   - Use a mechanism, as of this writing ipc::transport::Channel at least, that uses the following technique:</span></div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno">  144</span><span class="comment"> *     -# A process-wide Native_socket_stream connection is established using via the client-server method in the</span></div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno">  145</span><span class="comment"> *        above bullet point.</span></div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno">  146</span><span class="comment"> *     -# A socket-pair-generating OS call generates 2 pre-connected native stream-oriented Unix domain socket handles.</span></div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno">  147</span><span class="comment"> *        -# E.g., use boost.asio `asio_local_stream_socket::connect_pair()`.</span></div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno">  148</span><span class="comment"> *     -# 1 of the 2 handles is passed to the other side using the process-wide connection from step 1.</span></div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno">  149</span><span class="comment"> *     -# On each side, construct Native_socket_stream using the #Native_handle-taking ctor thus entering PEER</span></div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno">  150</span><span class="comment"> *        state directly at construction (on each side).</span></div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno">  151</span><span class="comment"> *</span></div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno">  152</span><span class="comment"> * Way 2 is better, because it requires no `Shared_name`s whatsoever, hence there are no thorny naming issues.</span></div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno">  153</span><span class="comment"> * The drawback is it requires an already-existing Native_socket_stream in order to transmit the handle!  Chicken/egg!</span></div>
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno">  154</span><span class="comment"> * Therefore, the informal recommendation is -- if practical -- use way 1 once (create chicken); then subsequently use</span></div>
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno">  155</span><span class="comment"> * way 2 as needed to easily create further connections.</span></div>
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno">  156</span><span class="comment"> *</span></div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno">  157</span><span class="comment"> * Native_socket_stream is move-constructible and move-assignable (but not copyable).  This is, at any rate,</span></div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno">  158</span><span class="comment"> * necessary to work with the boost.asio-style Native_socket_stream_acceptor::async_accept() API.</span></div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno">  159</span><span class="comment"> * A moved-from Native_socket_stream is as-if default-constructed; therefore it enters NULL state.</span></div>
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno">  160</span><span class="comment"> *</span></div>
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno">  161</span><span class="comment"> * (*) There is, in fact, another way -- one could call it way 2a.  It is just like way 2; except that -- upon</span></div>
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno">  162</span><span class="comment"> * obtaining a pre-connected `Native_handle` (one of a pair) -- one first constructs a &quot;`sync_io` core&quot;,</span></div>
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno">  163</span><span class="comment"> * namely a sync_io::Native_socket_stream object, using the *exact* same signature (which takes a `Logger*`,</span></div>
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno">  164</span><span class="comment"> * a nickname, and the pre-connected `Native_handle`).  Then, one constructs a `*this` by `move()`ing that</span></div>
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno">  165</span><span class="comment"> * guy into the `sync_io`-core-adopting ctor.  The result is exactly the same.  (Internally, whether one uses way 1</span></div>
<div class="line"><a id="l00166" name="l00166"></a><span class="lineno">  166</span><span class="comment"> * or way 2, `*this` will create a sync_io::Native_socket_stream core itself.  I tell you this, in case you are</span></div>
<div class="line"><a id="l00167" name="l00167"></a><span class="lineno">  167</span><span class="comment"> * curious.)</span></div>
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno">  168</span><span class="comment"> *</span></div>
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno">  169</span><span class="comment"> * ### Why no async-connect method, only sync-connect? ###</span></div>
<div class="line"><a id="l00170" name="l00170"></a><span class="lineno">  170</span><span class="comment"> * Without networking, the other side (Native_stream_socket_acceptor) either exists/is listening; or no.</span></div>
<div class="line"><a id="l00171" name="l00171"></a><span class="lineno">  171</span><span class="comment"> * Connecting is a synchronous, non-blocking operation; so an `async_connect()` API in this context only makes</span></div>
<div class="line"><a id="l00172" name="l00172"></a><span class="lineno">  172</span><span class="comment"> * life harder for the user.  (However, there are some serious plans to add a networking-capable counterpart</span></div>
<div class="line"><a id="l00173" name="l00173"></a><span class="lineno">  173</span><span class="comment"> * (probably via TCP at least) to Native_socket_stream; that one will almost certainly have an `async_connect()`,</span></div>
<div class="line"><a id="l00174" name="l00174"></a><span class="lineno">  174</span><span class="comment"> * while its `sync_connect()` will probably become potentially blocking.)</span></div>
<div class="line"><a id="l00175" name="l00175"></a><span class="lineno">  175</span><span class="comment"> *</span></div>
<div class="line"><a id="l00176" name="l00176"></a><span class="lineno">  176</span><span class="comment"> * If you are worried about attempting to connect to a Native_stream_socket_acceptor whose internal backlog limit has</span></div>
<div class="line"><a id="l00177" name="l00177"></a><span class="lineno">  177</span><span class="comment"> * been reached: please don&#39;t.  It won&#39;t happen; we have contemplated the details.</span></div>
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno">  178</span><span class="comment"> *</span></div>
<div class="line"><a id="l00179" name="l00179"></a><span class="lineno">  179</span><span class="comment"> * ### Thread safety ###</span></div>
<div class="line"><a id="l00180" name="l00180"></a><span class="lineno">  180</span><span class="comment"> * We add no more thread safety guarantees than those mandated by the main concepts.  To wit:</span></div>
<div class="line"><a id="l00181" name="l00181"></a><span class="lineno">  181</span><span class="comment"> *   - Concurrent access to 2 separate Native_socket_stream objects is safe.</span></div>
<div class="line"><a id="l00182" name="l00182"></a><span class="lineno">  182</span><span class="comment"> *   - After construction, concurrent access to the main transmission API methods (or</span></div>
<div class="line"><a id="l00183" name="l00183"></a><span class="lineno">  183</span><span class="comment"> *     remote_peer_process_credentials()) is not safe.</span></div>
<div class="line"><a id="l00184" name="l00184"></a><span class="lineno">  184</span><span class="comment"> *</span></div>
<div class="line"><a id="l00185" name="l00185"></a><span class="lineno">  185</span><span class="comment"> * @internal</span></div>
<div class="line"><a id="l00186" name="l00186"></a><span class="lineno">  186</span><span class="comment"> * ### Implementation design/rationale ###</span></div>
<div class="line"><a id="l00187" name="l00187"></a><span class="lineno">  187</span><span class="comment"> * Internally Native_socket_stream strictly uses the pImpl idiom (see https://en.cppreference.com/w/cpp/language/pimpl</span></div>
<div class="line"><a id="l00188" name="l00188"></a><span class="lineno">  188</span><span class="comment"> * for an excellent overview).  Very briefly:</span></div>
<div class="line"><a id="l00189" name="l00189"></a><span class="lineno">  189</span><span class="comment"> *   - The &quot;true&quot; Native_socket_stream is actually the self-contained, but not publicly exposed,</span></div>
<div class="line"><a id="l00190" name="l00190"></a><span class="lineno">  190</span><span class="comment"> *     Native_socket_stream::Impl class.</span></div>
<div class="line"><a id="l00191" name="l00191"></a><span class="lineno">  191</span><span class="comment"> *   - #m_impl is the `unique_ptr` to `*this` object&#39;s `Impl`.  This becomes null only when Native_socket_stream</span></div>
<div class="line"><a id="l00192" name="l00192"></a><span class="lineno">  192</span><span class="comment"> *     is moved-from; but if one attempts to call a method (such as sync_connect()) on the moved-from `*this`</span></div>
<div class="line"><a id="l00193" name="l00193"></a><span class="lineno">  193</span><span class="comment"> *     #m_impl is lazily re-initialized to a new default-cted (therefore NULL-state) Native_socket_stream::Impl.</span></div>
<div class="line"><a id="l00194" name="l00194"></a><span class="lineno">  194</span><span class="comment"> *   - Every public method of Native_socket_stream `*this` forwards to essentially the same-named method</span></div>
<div class="line"><a id="l00195" name="l00195"></a><span class="lineno">  195</span><span class="comment"> *     of `Impl` `*m_impl`.  `Impl` is an incomplete type inside the class declaration at all times;</span></div>
<div class="line"><a id="l00196" name="l00196"></a><span class="lineno">  196</span><span class="comment"> *     it becomes complete only inside the bodies of the (`Impl`-forwarding) public methods of Native_socket_stream.</span></div>
<div class="line"><a id="l00197" name="l00197"></a><span class="lineno">  197</span><span class="comment"> *     - The usual impl caveats apply: `Impl` must not have templated methods; so in particular the handler-taking</span></div>
<div class="line"><a id="l00198" name="l00198"></a><span class="lineno">  198</span><span class="comment"> *       method templates (such as async_receive_native_handle()) transform the parameterized arguments to</span></div>
<div class="line"><a id="l00199" name="l00199"></a><span class="lineno">  199</span><span class="comment"> *       concretely-typed objects (in this case `Function&lt;&gt;` objects such as `flow::async::Task_asio_err_sz`).</span></div>
<div class="line"><a id="l00200" name="l00200"></a><span class="lineno">  200</span><span class="comment"> *   - Because the implementation is 100% encapsulated inside the `Impl` #m_impl, move-assignment and move-construction</span></div>
<div class="line"><a id="l00201" name="l00201"></a><span class="lineno">  201</span><span class="comment"> *     are acquired for &quot;free&quot;:</span></div>
<div class="line"><a id="l00202" name="l00202"></a><span class="lineno">  202</span><span class="comment"> *     - Coding-ease &quot;free&quot;: Default-generated move-ctor and move-assignment simply move the `unique_ptr` #m_impl.</span></div>
<div class="line"><a id="l00203" name="l00203"></a><span class="lineno">  203</span><span class="comment"> *     - Perf &quot;free&quot;: `unique_ptr` move is lightning-quick (nullify the source pointer after copying the pointer value</span></div>
<div class="line"><a id="l00204" name="l00204"></a><span class="lineno">  204</span><span class="comment"> *       into the target pointer).</span></div>
<div class="line"><a id="l00205" name="l00205"></a><span class="lineno">  205</span><span class="comment"> *</span></div>
<div class="line"><a id="l00206" name="l00206"></a><span class="lineno">  206</span><span class="comment"> * Okay, if one is familiar with pImpl, none of this is surprising in terms of how it works.  *Why* though?  Answer:</span></div>
<div class="line"><a id="l00207" name="l00207"></a><span class="lineno">  207</span><span class="comment"> *   - I (ygoldfel) chose pImpl *not* to maintain a stable ABI/guarantee the implementation of methods can be changed</span></div>
<div class="line"><a id="l00208" name="l00208"></a><span class="lineno">  208</span><span class="comment"> *     without needing to recompile the code that `#include`s the present header file Native_socket_stream.hpp...</span></div>
<div class="line"><a id="l00209" name="l00209"></a><span class="lineno">  209</span><span class="comment"> *   - ...but rather specifically to get the move-ction and move-assignment for &quot;free&quot; as briefly explained above.</span></div>
<div class="line"><a id="l00210" name="l00210"></a><span class="lineno">  210</span><span class="comment"> *     - Consider the alternative.  Suppose Native_socket_stream is implemented directly inside Native_socket_stream</span></div>
<div class="line"><a id="l00211" name="l00211"></a><span class="lineno">  211</span><span class="comment"> *       itself; and we still want move-semantics available to the user.</span></div>
<div class="line"><a id="l00212" name="l00212"></a><span class="lineno">  212</span><span class="comment"> *     - Writing the move-ctor/assignment in and of itself is very much non-trivial.  The implementation involves</span></div>
<div class="line"><a id="l00213" name="l00213"></a><span class="lineno">  213</span><span class="comment"> *       many delicate data members including mutexes.  Swapping them properly, etc. etc., is no mean feat.</span></div>
<div class="line"><a id="l00214" name="l00214"></a><span class="lineno">  214</span><span class="comment"> *       Plus it&#39;s not exactly perf-y either.</span></div>
<div class="line"><a id="l00215" name="l00215"></a><span class="lineno">  215</span><span class="comment"> *     - Even having accomplished that, there is the following problem.  There is an internally maintained worker</span></div>
<div class="line"><a id="l00216" name="l00216"></a><span class="lineno">  216</span><span class="comment"> *       thread W which does much async work.  So consider something like a boost.asio `async_read_some(.., F)`</span></div>
<div class="line"><a id="l00217" name="l00217"></a><span class="lineno">  217</span><span class="comment"> *       call, where `F()` is the completion handler.  `F()` will be a lambda that captures `this` so it continue</span></div>
<div class="line"><a id="l00218" name="l00218"></a><span class="lineno">  218</span><span class="comment"> *       the async work chain.  But if `*this` is moved-from in the meantime, `this` is no longer pointing to the</span></div>
<div class="line"><a id="l00219" name="l00219"></a><span class="lineno">  219</span><span class="comment"> *       right object.  Making that work is difficult.</span></div>
<div class="line"><a id="l00220" name="l00220"></a><span class="lineno">  220</span><span class="comment"> *       - Yet with pImpl-facilitated move semantics it becomes trivial.  `Impl` is non-copyable, non-movable and can</span></div>
<div class="line"><a id="l00221" name="l00221"></a><span class="lineno">  221</span><span class="comment"> *         rely on a stable `this`.  Move semantics become entirely the concern of the wrapper Native_socket_stream:</span></div>
<div class="line"><a id="l00222" name="l00222"></a><span class="lineno">  222</span><span class="comment"> *         nice and clean.</span></div>
<div class="line"><a id="l00223" name="l00223"></a><span class="lineno">  223</span><span class="comment"> *</span></div>
<div class="line"><a id="l00224" name="l00224"></a><span class="lineno">  224</span><span class="comment"> * This leaves two questions.</span></div>
<div class="line"><a id="l00225" name="l00225"></a><span class="lineno">  225</span><span class="comment"> *   - One: why do we want public move-semantics anyway?  Why not just provide a non-movable Native_socket_stream</span></div>
<div class="line"><a id="l00226" name="l00226"></a><span class="lineno">  226</span><span class="comment"> *     and let the user worry about wrapping it in a `shared_ptr` or `unique_ptr`, if they want to move these objects</span></div>
<div class="line"><a id="l00227" name="l00227"></a><span class="lineno">  227</span><span class="comment"> *     around?  Answer: Sure, that&#39;s perfectly reasonable.  However:</span></div>
<div class="line"><a id="l00228" name="l00228"></a><span class="lineno">  228</span><span class="comment"> *     - Native_socket_stream_acceptor would need to impose shared-ownership/factory API in supplying the connected</span></div>
<div class="line"><a id="l00229" name="l00229"></a><span class="lineno">  229</span><span class="comment"> *       Native_socket_stream to the user asynchronously.  That could be fine -- but it&#39;d be nice to have</span></div>
<div class="line"><a id="l00230" name="l00230"></a><span class="lineno">  230</span><span class="comment"> *       acceptor semantics that are like boost.asio&#39;s as opposed to our own design.</span></div>
<div class="line"><a id="l00231" name="l00231"></a><span class="lineno">  231</span><span class="comment"> *     - Nevertheless Native_socket_stream_acceptor API could still be designed in factory fashion, even if it&#39;s</span></div>
<div class="line"><a id="l00232" name="l00232"></a><span class="lineno">  232</span><span class="comment"> *       inconsistent with what boost.asio users might expect.  But: now consider the other guys implementing</span></div>
<div class="line"><a id="l00233" name="l00233"></a><span class="lineno">  233</span><span class="comment"> *       Blob_sender and Blob_receiver, namely the message queue-based (MQ-based) Blob_stream_mq_sender and</span></div>
<div class="line"><a id="l00234" name="l00234"></a><span class="lineno">  234</span><span class="comment"> *       and Blob_stream_mq_receiver.  They don&#39;t use an acceptor API at all by their nature; and hence they don&#39;t</span></div>
<div class="line"><a id="l00235" name="l00235"></a><span class="lineno">  235</span><span class="comment"> *       need any factory semantics.  So now some Blob_sender and Blob_receiver implementing classes use ownership</span></div>
<div class="line"><a id="l00236" name="l00236"></a><span class="lineno">  236</span><span class="comment"> *       semantics X, while others (Native_socket_stream) use ownership semantics Y -- despite implementing the</span></div>
<div class="line"><a id="l00237" name="l00237"></a><span class="lineno">  237</span><span class="comment"> *       same concepts.  Is this okay?  Sure, it&#39;s not bad; but it&#39;s not ideal all in all.</span></div>
<div class="line"><a id="l00238" name="l00238"></a><span class="lineno">  238</span><span class="comment"> *     - Therefore for consistency inside the overall ipc::transport API, as well as versus boost.asio API,</span></div>
<div class="line"><a id="l00239" name="l00239"></a><span class="lineno">  239</span><span class="comment"> *       making Native_socket_stream directly constructible (and movable when needed for acceptor semantics)</span></div>
<div class="line"><a id="l00240" name="l00240"></a><span class="lineno">  240</span><span class="comment"> *       ultimately is the nicer approach.  (Historical note: An early version of this class and</span></div>
<div class="line"><a id="l00241" name="l00241"></a><span class="lineno">  241</span><span class="comment"> *       Native_socket_stream_acceptor indeed used the alternative, factory-based approach.  So we&#39;ve tried both.)</span></div>
<div class="line"><a id="l00242" name="l00242"></a><span class="lineno">  242</span><span class="comment"> *   - Two: what about the negatives of pImpl?  It is after all a trade-off.  I won&#39;t go over all the negatives here</span></div>
<div class="line"><a id="l00243" name="l00243"></a><span class="lineno">  243</span><span class="comment"> *     &quot;formally&quot; (see the cppreference.com page mentioned above for a survey).  Long story short:</span></div>
<div class="line"><a id="l00244" name="l00244"></a><span class="lineno">  244</span><span class="comment"> *     - The indirection of all calls through a pointer is probably a minor perf hit in and of itself.</span></div>
<div class="line"><a id="l00245" name="l00245"></a><span class="lineno">  245</span><span class="comment"> *       - Factories involve their own perf hits, particularly since typically they use `shared_ptr` and not</span></div>
<div class="line"><a id="l00246" name="l00246"></a><span class="lineno">  246</span><span class="comment"> *         `unique_ptr` (which is quite quick in comparison).</span></div>
<div class="line"><a id="l00247" name="l00247"></a><span class="lineno">  247</span><span class="comment"> *     - The laborious need to code a copy of the entire public API, so as to forward to `Impl`, is *easily*</span></div>
<div class="line"><a id="l00248" name="l00248"></a><span class="lineno">  248</span><span class="comment"> *       no big deal compared to what it would take to make Native_socket_stream movable directly.</span></div>
<div class="line"><a id="l00249" name="l00249"></a><span class="lineno">  249</span><span class="comment"> *     - pImpl is not inlining-friendly and cannot be used for a header-only library.  However:</span></div>
<div class="line"><a id="l00250" name="l00250"></a><span class="lineno">  250</span><span class="comment"> *       - The entire Flow-IPC library -- and all of Flow too -- to begin with refuses to be inlining-friendly and</span></div>
<div class="line"><a id="l00251" name="l00251"></a><span class="lineno">  251</span><span class="comment"> *         header-only; so this does not change that.</span></div>
<div class="line"><a id="l00252" name="l00252"></a><span class="lineno">  252</span><span class="comment"> *       - Both Flow-IPC and Flow encourage the use of LTO which will inline everything anyway.</span></div>
<div class="line"><a id="l00253" name="l00253"></a><span class="lineno">  253</span><span class="comment"> *         If LTO is not available then the resulting perf loss already applies to both libraries; so this</span></div>
<div class="line"><a id="l00254" name="l00254"></a><span class="lineno">  254</span><span class="comment"> *         does not change that.  Conversely adding LTO will benefit everything including Native_socket_stream.</span></div>
<div class="line"><a id="l00255" name="l00255"></a><span class="lineno">  255</span><span class="comment"> *       - So we are consistent in this decision for better or worse.</span></div>
<div class="line"><a id="l00256" name="l00256"></a><span class="lineno">  256</span><span class="comment"> *</span></div>
<div class="line"><a id="l00257" name="l00257"></a><span class="lineno">  257</span><span class="comment"> * That&#39;s my (ygoldfel) story, and I am sticking to it.</span></div>
<div class="line"><a id="l00258" name="l00258"></a><span class="lineno">  258</span><span class="comment"> *</span></div>
<div class="line"><a id="l00259" name="l00259"></a><span class="lineno">  259</span><span class="comment"> * The rest of the implementation is inside Native_socket_stream::Impl and is discussed in that class&#39;s doc header.</span></div>
<div class="line"><a id="l00260" name="l00260"></a><span class="lineno">  260</span><span class="comment"> *</span></div>
<div class="line"><a id="l00261" name="l00261"></a><span class="lineno">  261</span><span class="comment"> * @see Native_socket_stream::Impl doc header.</span></div>
<div class="line"><a id="l00262" name="l00262"></a><span class="lineno">  262</span><span class="comment"> *</span></div>
<div class="line"><a id="l00263" name="l00263"></a><span class="lineno">  263</span><span class="comment"> * @endinternal</span></div>
<div class="line"><a id="l00264" name="l00264"></a><span class="lineno">  264</span><span class="comment"> *</span></div>
<div class="line"><a id="l00265" name="l00265"></a><span class="lineno">  265</span><span class="comment"> * @see Native_handle_sender: implemented concept.</span></div>
<div class="line"><a id="l00266" name="l00266"></a><span class="lineno">  266</span><span class="comment"> * @see Native_handle_receiver: implemented concept.</span></div>
<div class="line"><a id="l00267" name="l00267"></a><span class="lineno">  267</span><span class="comment"> * @see Blob_sender: alternatively implemented concept.</span></div>
<div class="line"><a id="l00268" name="l00268"></a><span class="lineno">  268</span><span class="comment"> * @see Blob_receiver: alternatively implemented concept.</span></div>
<div class="line"><a id="l00269" name="l00269"></a><span class="lineno">  269</span><span class="comment"> */</span></div>
<div class="line"><a id="l00270" name="l00270"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1Native__socket__stream.html">  270</a></span><span class="keyword">class </span><a class="code hl_class" href="classipc_1_1transport_1_1Native__socket__stream.html">Native_socket_stream</a></div>
<div class="line"><a id="l00271" name="l00271"></a><span class="lineno">  271</span>{</div>
<div class="line"><a id="l00272" name="l00272"></a><span class="lineno">  272</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00273" name="l00273"></a><span class="lineno">  273</span>  <span class="comment">// Types.</span></div>
<div class="line"><a id="l00274" name="l00274"></a><span class="lineno">  274</span><span class="comment"></span> </div>
<div class="line"><a id="l00275" name="l00275"></a><span class="lineno">  275</span><span class="comment">  /// Useful for generic programming, the `sync_io`-pattern counterpart to `*this` type.</span></div>
<div class="line"><a id="l00276" name="l00276"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1Native__socket__stream.html#a850af22a95f27d8696b9b5bca15454b5">  276</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_class" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream.html">Sync_io_obj</a> = <a class="code hl_class" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream.html">sync_io::Native_socket_stream</a>;<span class="comment"></span></div>
<div class="line"><a id="l00277" name="l00277"></a><span class="lineno">  277</span><span class="comment">  /// You may disregard.</span></div>
<div class="line"><a id="l00278" name="l00278"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1Native__socket__stream.html#a5401e1f0e8cd4a6cc8c31373da5df982">  278</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_class" href="classipc_1_1transport_1_1Null__peer.html">Async_io_obj</a> = <a class="code hl_class" href="classipc_1_1transport_1_1Null__peer.html">Null_peer</a>;</div>
<div class="line"><a id="l00279" name="l00279"></a><span class="lineno">  279</span> </div>
<div class="line"><a id="l00280" name="l00280"></a><span class="lineno">  280</span>  <span class="comment">// Constants.</span></div>
<div class="line"><a id="l00281" name="l00281"></a><span class="lineno">  281</span><span class="comment"></span> </div>
<div class="line"><a id="l00282" name="l00282"></a><span class="lineno">  282</span><span class="comment">  /// Implements concept API.</span></div>
<div class="line"><a id="l00283" name="l00283"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1Native__socket__stream.html#a6271d2cc490f82197990c70be5d8747e">  283</a></span><span class="comment"></span>  <span class="keyword">static</span> <span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a>&amp; <a class="code hl_variable" href="classipc_1_1transport_1_1Native__socket__stream.html#a6271d2cc490f82197990c70be5d8747e">S_RESOURCE_TYPE_ID</a>;</div>
<div class="line"><a id="l00284" name="l00284"></a><span class="lineno">  284</span><span class="comment"></span> </div>
<div class="line"><a id="l00285" name="l00285"></a><span class="lineno">  285</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00286" name="l00286"></a><span class="lineno">  286</span><span class="comment">   * Implements concept API; namely it is `true`: async_receive_native_handle() with</span></div>
<div class="line"><a id="l00287" name="l00287"></a><span class="lineno">  287</span><span class="comment">   * smaller-than-`receive_meta_blob_max_size()` size shall *not* lead to error::Code::S_INVALID_ARGUMENT; hence</span></div>
<div class="line"><a id="l00288" name="l00288"></a><span class="lineno">  288</span><span class="comment">   * error::Code::S_MESSAGE_SIZE_EXCEEDS_USER_STORAGE is possible.</span></div>
<div class="line"><a id="l00289" name="l00289"></a><span class="lineno">  289</span><span class="comment">   *</span></div>
<div class="line"><a id="l00290" name="l00290"></a><span class="lineno">  290</span><span class="comment">   * @see Native_handle_receiver::S_META_BLOB_UNDERFLOW_ALLOWED: implemented concept.  Accordingly also see</span></div>
<div class="line"><a id="l00291" name="l00291"></a><span class="lineno">  291</span><span class="comment">   *      &quot;Blob underflow semantics&quot; in that concept class&#39;s doc header for potentially important discussion.</span></div>
<div class="line"><a id="l00292" name="l00292"></a><span class="lineno">  292</span><span class="comment">   */</span></div>
<div class="line"><a id="l00293" name="l00293"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1Native__socket__stream.html#a859615800ba1e0546c8e5cb8a6796e41">  293</a></span>  <span class="keyword">static</span> <span class="keyword">constexpr</span> <span class="keywordtype">bool</span> <a class="code hl_variable" href="classipc_1_1transport_1_1Native__socket__stream.html#a859615800ba1e0546c8e5cb8a6796e41">S_META_BLOB_UNDERFLOW_ALLOWED</a> = <span class="keyword">true</span>;</div>
<div class="line"><a id="l00294" name="l00294"></a><span class="lineno">  294</span><span class="comment"></span> </div>
<div class="line"><a id="l00295" name="l00295"></a><span class="lineno">  295</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00296" name="l00296"></a><span class="lineno">  296</span><span class="comment">   * Implements concept API; namely it is `true`: async_receive_blob() with smaller-than-`receive_blob_max_size()`</span></div>
<div class="line"><a id="l00297" name="l00297"></a><span class="lineno">  297</span><span class="comment">   * size shall *not* lead to error::Code::S_INVALID_ARGUMENT; hence error::Code::S_MESSAGE_SIZE_EXCEEDS_USER_STORAGE</span></div>
<div class="line"><a id="l00298" name="l00298"></a><span class="lineno">  298</span><span class="comment">   * is possible.</span></div>
<div class="line"><a id="l00299" name="l00299"></a><span class="lineno">  299</span><span class="comment">   *</span></div>
<div class="line"><a id="l00300" name="l00300"></a><span class="lineno">  300</span><span class="comment">   * @see Blob_receiver::S_BLOB_UNDERFLOW_ALLOWED: implemented concept.  Accordingly also see</span></div>
<div class="line"><a id="l00301" name="l00301"></a><span class="lineno">  301</span><span class="comment">   *      &quot;Blob underflow semantics&quot; in sister concept class&#39;s doc header for potentially important discussion.</span></div>
<div class="line"><a id="l00302" name="l00302"></a><span class="lineno">  302</span><span class="comment">   */</span></div>
<div class="line"><a id="l00303" name="l00303"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1Native__socket__stream.html#a59d4ec9f05762a8bc2db4b752d4fd5f4">  303</a></span>  <span class="keyword">static</span> <span class="keyword">constexpr</span> <span class="keywordtype">bool</span> <a class="code hl_variable" href="classipc_1_1transport_1_1Native__socket__stream.html#a59d4ec9f05762a8bc2db4b752d4fd5f4">S_BLOB_UNDERFLOW_ALLOWED</a> = <span class="keyword">true</span>;</div>
<div class="line"><a id="l00304" name="l00304"></a><span class="lineno">  304</span> </div>
<div class="line"><a id="l00305" name="l00305"></a><span class="lineno">  305</span>  <span class="comment">// Constructors/destructor.</span></div>
<div class="line"><a id="l00306" name="l00306"></a><span class="lineno">  306</span><span class="comment"></span> </div>
<div class="line"><a id="l00307" name="l00307"></a><span class="lineno">  307</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00308" name="l00308"></a><span class="lineno">  308</span><span class="comment">   * Default ctor (object is in NULL state).</span></div>
<div class="line"><a id="l00309" name="l00309"></a><span class="lineno">  309</span><span class="comment">   * Implements Native_handle_sender *and* Native_handle_receiver APIs at the same time, per their concept contracts.</span></div>
<div class="line"><a id="l00310" name="l00310"></a><span class="lineno">  310</span><span class="comment">   * (Also implements Blob_sender *and* Blob_receiver APIs; they are identical.)</span></div>
<div class="line"><a id="l00311" name="l00311"></a><span class="lineno">  311</span><span class="comment">   * All the notes for both concepts&#39; default ctors apply.</span></div>
<div class="line"><a id="l00312" name="l00312"></a><span class="lineno">  312</span><span class="comment">   *</span></div>
<div class="line"><a id="l00313" name="l00313"></a><span class="lineno">  313</span><span class="comment">   * This ctor is informally intended for the following uses:</span></div>
<div class="line"><a id="l00314" name="l00314"></a><span class="lineno">  314</span><span class="comment">   *   - A moved-from Native_socket_stream (i.e., the `src` arg move-ctor and move-assignment operator)</span></div>
<div class="line"><a id="l00315" name="l00315"></a><span class="lineno">  315</span><span class="comment">   *     becomes as-if defaulted-constructed.</span></div>
<div class="line"><a id="l00316" name="l00316"></a><span class="lineno">  316</span><span class="comment">   *   - A target Native_socket_stream for Native_socket_stream_acceptor::async_accept() shall typically be</span></div>
<div class="line"><a id="l00317" name="l00317"></a><span class="lineno">  317</span><span class="comment">   *     default-cted; Native_socket_stream_acceptor shall asynchronously move-assign a logger-apointed,</span></div>
<div class="line"><a id="l00318" name="l00318"></a><span class="lineno">  318</span><span class="comment">   *     nicely-nicknamed into that target `*this`.</span></div>
<div class="line"><a id="l00319" name="l00319"></a><span class="lineno">  319</span><span class="comment">   *</span></div>
<div class="line"><a id="l00320" name="l00320"></a><span class="lineno">  320</span><span class="comment">   * Therefore it would be unusual (though allowed) to make direct calls such as sync_connect() and send_blob()</span></div>
<div class="line"><a id="l00321" name="l00321"></a><span class="lineno">  321</span><span class="comment">   * on a default-cted Native_socket_stream without first moving a non-default-cted object into it.</span></div>
<div class="line"><a id="l00322" name="l00322"></a><span class="lineno">  322</span><span class="comment">   *</span></div>
<div class="line"><a id="l00323" name="l00323"></a><span class="lineno">  323</span><span class="comment">   * @see Native_handle_sender::Native_handle_sender(): implemented concept.</span></div>
<div class="line"><a id="l00324" name="l00324"></a><span class="lineno">  324</span><span class="comment">   * @see Native_handle_receiver::Native_handle_receiver(): implemented concept.</span></div>
<div class="line"><a id="l00325" name="l00325"></a><span class="lineno">  325</span><span class="comment">   * @see Blob_sender::Blob_sender(): implemented concept.</span></div>
<div class="line"><a id="l00326" name="l00326"></a><span class="lineno">  326</span><span class="comment">   * @see Blob_receiver::Blob_receiver(): implemented concept.</span></div>
<div class="line"><a id="l00327" name="l00327"></a><span class="lineno">  327</span><span class="comment">   */</span></div>
<div class="line"><a id="l00328" name="l00328"></a><span class="lineno">  328</span>  <a class="code hl_function" href="classipc_1_1transport_1_1Native__socket__stream.html#aae823547a7ad0b9fdc691eb40c94d7da">Native_socket_stream</a>();</div>
<div class="line"><a id="l00329" name="l00329"></a><span class="lineno">  329</span><span class="comment"></span> </div>
<div class="line"><a id="l00330" name="l00330"></a><span class="lineno">  330</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00331" name="l00331"></a><span class="lineno">  331</span><span class="comment">   * Creates a Native_socket_stream in NULL (not connected) state.</span></div>
<div class="line"><a id="l00332" name="l00332"></a><span class="lineno">  332</span><span class="comment">   *</span></div>
<div class="line"><a id="l00333" name="l00333"></a><span class="lineno">  333</span><span class="comment">   * This ctor is informally intended for the following use:</span></div>
<div class="line"><a id="l00334" name="l00334"></a><span class="lineno">  334</span><span class="comment">   *   - You create a Native_socket_stream that is logger-appointed and nicely-nicknamed; then you call</span></div>
<div class="line"><a id="l00335" name="l00335"></a><span class="lineno">  335</span><span class="comment">   *     sync_connect() on it in order to move it to, hopefully, PEER states.</span></div>
<div class="line"><a id="l00336" name="l00336"></a><span class="lineno">  336</span><span class="comment">   *     It will retain the logger and nickname throughout.</span></div>
<div class="line"><a id="l00337" name="l00337"></a><span class="lineno">  337</span><span class="comment">   *</span></div>
<div class="line"><a id="l00338" name="l00338"></a><span class="lineno">  338</span><span class="comment">   * Alternatively:</span></div>
<div class="line"><a id="l00339" name="l00339"></a><span class="lineno">  339</span><span class="comment">   *   - If you intend to get a Native_socket_stream from a pre-connected #Native_handle:</span></div>
<div class="line"><a id="l00340" name="l00340"></a><span class="lineno">  340</span><span class="comment">   *     Use that Native_socket_stream ctor.</span></div>
<div class="line"><a id="l00341" name="l00341"></a><span class="lineno">  341</span><span class="comment">   *   - If you intend to get a Native_socket_stream by accepting it server-style:</span></div>
<div class="line"><a id="l00342" name="l00342"></a><span class="lineno">  342</span><span class="comment">   *     Use the default Native_socket_stream ctor; pass that object to Native_socket_stream_acceptor::async_accept().</span></div>
<div class="line"><a id="l00343" name="l00343"></a><span class="lineno">  343</span><span class="comment">   *</span></div>
<div class="line"><a id="l00344" name="l00344"></a><span class="lineno">  344</span><span class="comment">   * @param logger_ptr</span></div>
<div class="line"><a id="l00345" name="l00345"></a><span class="lineno">  345</span><span class="comment">   *        Logger to use for subsequently logging.</span></div>
<div class="line"><a id="l00346" name="l00346"></a><span class="lineno">  346</span><span class="comment">   * @param nickname_str</span></div>
<div class="line"><a id="l00347" name="l00347"></a><span class="lineno">  347</span><span class="comment">   *        Human-readable nickname of the new object, as of this writing for use in `operator&lt;&lt;(ostream)` and</span></div>
<div class="line"><a id="l00348" name="l00348"></a><span class="lineno">  348</span><span class="comment">   *        logging only.</span></div>
<div class="line"><a id="l00349" name="l00349"></a><span class="lineno">  349</span><span class="comment">   */</span></div>
<div class="line"><a id="l00350" name="l00350"></a><span class="lineno">  350</span>  <span class="keyword">explicit</span> <a class="code hl_function" href="classipc_1_1transport_1_1Native__socket__stream.html#aae823547a7ad0b9fdc691eb40c94d7da">Native_socket_stream</a>(flow::log::Logger* logger_ptr, <a class="code hl_typedef" href="namespaceipc_1_1util.html#ae6ac47812a90d1287c61e0b7de7bc4f5">util::String_view</a> nickname_str);</div>
<div class="line"><a id="l00351" name="l00351"></a><span class="lineno">  351</span><span class="comment"></span> </div>
<div class="line"><a id="l00352" name="l00352"></a><span class="lineno">  352</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00353" name="l00353"></a><span class="lineno">  353</span><span class="comment">   * Constructs the socket-and-meta-blob stream by taking over an already-connected native Unix domain socket handle.</span></div>
<div class="line"><a id="l00354" name="l00354"></a><span class="lineno">  354</span><span class="comment">   * The socket must be freshly connected without any traffic exchanged on the connection so far; otherwise behavior</span></div>
<div class="line"><a id="l00355" name="l00355"></a><span class="lineno">  355</span><span class="comment">   * undefined.</span></div>
<div class="line"><a id="l00356" name="l00356"></a><span class="lineno">  356</span><span class="comment">   *</span></div>
<div class="line"><a id="l00357" name="l00357"></a><span class="lineno">  357</span><span class="comment">   * ### Performance ###</span></div>
<div class="line"><a id="l00358" name="l00358"></a><span class="lineno">  358</span><span class="comment">   * The taking over of `native_peer_socket_moved` should be thought of as light-weight.</span></div>
<div class="line"><a id="l00359" name="l00359"></a><span class="lineno">  359</span><span class="comment">   *</span></div>
<div class="line"><a id="l00360" name="l00360"></a><span class="lineno">  360</span><span class="comment">   * @param logger_ptr</span></div>
<div class="line"><a id="l00361" name="l00361"></a><span class="lineno">  361</span><span class="comment">   *        Logger to use for subsequently logging.</span></div>
<div class="line"><a id="l00362" name="l00362"></a><span class="lineno">  362</span><span class="comment">   * @param native_peer_socket_moved</span></div>
<div class="line"><a id="l00363" name="l00363"></a><span class="lineno">  363</span><span class="comment">   *        The wrapped native handle shall be taken over by `*this`; and this wrapper object will be made</span></div>
<div class="line"><a id="l00364" name="l00364"></a><span class="lineno">  364</span><span class="comment">   *        `.null() == true`.  In plainer English, the main point is, this is the native socket</span></div>
<div class="line"><a id="l00365" name="l00365"></a><span class="lineno">  365</span><span class="comment">   *        over which traffic will proceed.</span></div>
<div class="line"><a id="l00366" name="l00366"></a><span class="lineno">  366</span><span class="comment">   * @param nickname_str</span></div>
<div class="line"><a id="l00367" name="l00367"></a><span class="lineno">  367</span><span class="comment">   *        Human-readable nickname of the new object, as of this writing for use in `operator&lt;&lt;(ostream)` and</span></div>
<div class="line"><a id="l00368" name="l00368"></a><span class="lineno">  368</span><span class="comment">   *        logging only.</span></div>
<div class="line"><a id="l00369" name="l00369"></a><span class="lineno">  369</span><span class="comment">   */</span></div>
<div class="line"><a id="l00370" name="l00370"></a><span class="lineno">  370</span>  <span class="keyword">explicit</span> <a class="code hl_function" href="classipc_1_1transport_1_1Native__socket__stream.html#aae823547a7ad0b9fdc691eb40c94d7da">Native_socket_stream</a>(flow::log::Logger* logger_ptr, <a class="code hl_typedef" href="namespaceipc_1_1util.html#ae6ac47812a90d1287c61e0b7de7bc4f5">util::String_view</a> nickname_str,</div>
<div class="line"><a id="l00371" name="l00371"></a><span class="lineno">  371</span>                                <a class="code hl_struct" href="structipc_1_1util_1_1Native__handle.html">Native_handle</a>&amp;&amp; native_peer_socket_moved);</div>
<div class="line"><a id="l00372" name="l00372"></a><span class="lineno">  372</span><span class="comment"></span> </div>
<div class="line"><a id="l00373" name="l00373"></a><span class="lineno">  373</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00374" name="l00374"></a><span class="lineno">  374</span><span class="comment">   * Implements Native_handle_sender *and* Native_handle_receiver APIs at the same time, per their concept contracts.</span></div>
<div class="line"><a id="l00375" name="l00375"></a><span class="lineno">  375</span><span class="comment">   * (Also implements Blob_sender *and* Blob_receiver APIs; they are identical.)</span></div>
<div class="line"><a id="l00376" name="l00376"></a><span class="lineno">  376</span><span class="comment">   *</span></div>
<div class="line"><a id="l00377" name="l00377"></a><span class="lineno">  377</span><span class="comment">   * ### Performance ###</span></div>
<div class="line"><a id="l00378" name="l00378"></a><span class="lineno">  378</span><span class="comment">   * The taking over of `sync_io_core_in_peer_state_moved` should be thought of as light-weight.</span></div>
<div class="line"><a id="l00379" name="l00379"></a><span class="lineno">  379</span><span class="comment">   *</span></div>
<div class="line"><a id="l00380" name="l00380"></a><span class="lineno">  380</span><span class="comment">   * @param sync_io_core_in_peer_state_moved</span></div>
<div class="line"><a id="l00381" name="l00381"></a><span class="lineno">  381</span><span class="comment">   *        See above.</span></div>
<div class="line"><a id="l00382" name="l00382"></a><span class="lineno">  382</span><span class="comment">   *</span></div>
<div class="line"><a id="l00383" name="l00383"></a><span class="lineno">  383</span><span class="comment">   * @see Native_handle_sender::~Native_handle_sender(): implemented concept.</span></div>
<div class="line"><a id="l00384" name="l00384"></a><span class="lineno">  384</span><span class="comment">   * @see Native_handle_receiver::~Native_handle_receiver(): implemented concept.</span></div>
<div class="line"><a id="l00385" name="l00385"></a><span class="lineno">  385</span><span class="comment">   * @see Blob_sender::~Blob_sender(): alternatively implemented concept.</span></div>
<div class="line"><a id="l00386" name="l00386"></a><span class="lineno">  386</span><span class="comment">   * @see Blob_receiver::~Blob_receiver(): alternatively implemented concept.</span></div>
<div class="line"><a id="l00387" name="l00387"></a><span class="lineno">  387</span><span class="comment">   */</span></div>
<div class="line"><a id="l00388" name="l00388"></a><span class="lineno">  388</span>  <span class="keyword">explicit</span> <a class="code hl_function" href="classipc_1_1transport_1_1Native__socket__stream.html#aae823547a7ad0b9fdc691eb40c94d7da">Native_socket_stream</a>(<a class="code hl_class" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream.html">Sync_io_obj</a>&amp;&amp; sync_io_core_in_peer_state_moved);</div>
<div class="line"><a id="l00389" name="l00389"></a><span class="lineno">  389</span><span class="comment"></span> </div>
<div class="line"><a id="l00390" name="l00390"></a><span class="lineno">  390</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00391" name="l00391"></a><span class="lineno">  391</span><span class="comment">   * Move-constructs from `src`; `src` becomes as-if default-cted (therefore in NULL state).</span></div>
<div class="line"><a id="l00392" name="l00392"></a><span class="lineno">  392</span><span class="comment">   * Implements Native_handle_sender *and* Native_handle_receiver APIs at the same time, per their concept contracts.</span></div>
<div class="line"><a id="l00393" name="l00393"></a><span class="lineno">  393</span><span class="comment">   * (Also implements Blob_sender *and* Blob_receiver APIs; they are identical.)</span></div>
<div class="line"><a id="l00394" name="l00394"></a><span class="lineno">  394</span><span class="comment">   *</span></div>
<div class="line"><a id="l00395" name="l00395"></a><span class="lineno">  395</span><span class="comment">   * @param src</span></div>
<div class="line"><a id="l00396" name="l00396"></a><span class="lineno">  396</span><span class="comment">   *        See above.</span></div>
<div class="line"><a id="l00397" name="l00397"></a><span class="lineno">  397</span><span class="comment">   *</span></div>
<div class="line"><a id="l00398" name="l00398"></a><span class="lineno">  398</span><span class="comment">   * @see Native_handle_sender::Native_handle_sender(): implemented concept.</span></div>
<div class="line"><a id="l00399" name="l00399"></a><span class="lineno">  399</span><span class="comment">   * @see Native_handle_receiver::Native_handle_receiver(): implemented concept.</span></div>
<div class="line"><a id="l00400" name="l00400"></a><span class="lineno">  400</span><span class="comment">   * @see Blob_sender::Blob_sender(): implemented concept.</span></div>
<div class="line"><a id="l00401" name="l00401"></a><span class="lineno">  401</span><span class="comment">   * @see Blob_receiver::Blob_receiver(): implemented concept.</span></div>
<div class="line"><a id="l00402" name="l00402"></a><span class="lineno">  402</span><span class="comment">   */</span></div>
<div class="line"><a id="l00403" name="l00403"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1Native__socket__stream.html#a433d09587c6d854e59c12d4f483516fb">  403</a></span>  <a class="code hl_function" href="classipc_1_1transport_1_1Native__socket__stream.html#a433d09587c6d854e59c12d4f483516fb">Native_socket_stream</a>(<a class="code hl_class" href="classipc_1_1transport_1_1Native__socket__stream.html">Native_socket_stream</a>&amp;&amp; src);</div>
<div class="line"><a id="l00404" name="l00404"></a><span class="lineno">  404</span><span class="comment"></span> </div>
<div class="line"><a id="l00405" name="l00405"></a><span class="lineno">  405</span><span class="comment">  /// Copy construction is disallowed.</span></div>
<div class="line"><a id="l00406" name="l00406"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1Native__socket__stream.html#a11409650b45a575743371169226aaf7c">  406</a></span><span class="comment"></span>  <a class="code hl_function" href="classipc_1_1transport_1_1Native__socket__stream.html#a11409650b45a575743371169226aaf7c">Native_socket_stream</a>(<span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1transport_1_1Native__socket__stream.html">Native_socket_stream</a>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00407" name="l00407"></a><span class="lineno">  407</span><span class="comment"></span> </div>
<div class="line"><a id="l00408" name="l00408"></a><span class="lineno">  408</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00409" name="l00409"></a><span class="lineno">  409</span><span class="comment">   * Implements Native_handle_sender *and* Native_handle_receiver APIs at the same time, per their concept contracts.</span></div>
<div class="line"><a id="l00410" name="l00410"></a><span class="lineno">  410</span><span class="comment">   * (Also implements Blob_sender *and* Blob_receiver APIs; they are identical.)</span></div>
<div class="line"><a id="l00411" name="l00411"></a><span class="lineno">  411</span><span class="comment">   * All the notes for both concepts&#39; destructors apply but as a reminder:</span></div>
<div class="line"><a id="l00412" name="l00412"></a><span class="lineno">  412</span><span class="comment">   *</span></div>
<div class="line"><a id="l00413" name="l00413"></a><span class="lineno">  413</span><span class="comment">   * Destroys this peer endpoint which will end both-direction pipes (of those still open) and cancel any pending</span></div>
<div class="line"><a id="l00414" name="l00414"></a><span class="lineno">  414</span><span class="comment">   * completion handlers by invoking them ASAP with error::Code::S_OBJECT_SHUTDOWN_ABORTED_COMPLETION_HANDLER.</span></div>
<div class="line"><a id="l00415" name="l00415"></a><span class="lineno">  415</span><span class="comment">   * As of this writing these are the completion handlers that would therefore be called:</span></div>
<div class="line"><a id="l00416" name="l00416"></a><span class="lineno">  416</span><span class="comment">   *   - Any handler passed to async_receive_native_handle() that has not yet been invoked.</span></div>
<div class="line"><a id="l00417" name="l00417"></a><span class="lineno">  417</span><span class="comment">   *     There can be 0 or more of these.</span></div>
<div class="line"><a id="l00418" name="l00418"></a><span class="lineno">  418</span><span class="comment">   *   - The handler passed to async_end_sending().</span></div>
<div class="line"><a id="l00419" name="l00419"></a><span class="lineno">  419</span><span class="comment">   *     Since it is not valid to call async_end_sending() more than once, there is at most 1 of these.</span></div>
<div class="line"><a id="l00420" name="l00420"></a><span class="lineno">  420</span><span class="comment">   *</span></div>
<div class="line"><a id="l00421" name="l00421"></a><span class="lineno">  421</span><span class="comment">   * @see Native_handle_sender::~Native_handle_sender(): implemented concept.</span></div>
<div class="line"><a id="l00422" name="l00422"></a><span class="lineno">  422</span><span class="comment">   * @see Native_handle_receiver::~Native_handle_receiver(): implemented concept.</span></div>
<div class="line"><a id="l00423" name="l00423"></a><span class="lineno">  423</span><span class="comment">   * @see Blob_sender::~Blob_sender(): alternatively implemented concept.</span></div>
<div class="line"><a id="l00424" name="l00424"></a><span class="lineno">  424</span><span class="comment">   * @see Blob_receiver::~Blob_receiver(): alternatively implemented concept.</span></div>
<div class="line"><a id="l00425" name="l00425"></a><span class="lineno">  425</span><span class="comment">   */</span></div>
<div class="line"><a id="l00426" name="l00426"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1Native__socket__stream.html#a1ff9e6811c0d662a6a960602be5926e0">  426</a></span>  <a class="code hl_function" href="classipc_1_1transport_1_1Native__socket__stream.html#a1ff9e6811c0d662a6a960602be5926e0">~Native_socket_stream</a>();</div>
<div class="line"><a id="l00427" name="l00427"></a><span class="lineno">  427</span> </div>
<div class="line"><a id="l00428" name="l00428"></a><span class="lineno">  428</span>  <span class="comment">// Methods.</span></div>
<div class="line"><a id="l00429" name="l00429"></a><span class="lineno">  429</span><span class="comment"></span> </div>
<div class="line"><a id="l00430" name="l00430"></a><span class="lineno">  430</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00431" name="l00431"></a><span class="lineno">  431</span><span class="comment">   * Move-assigns from `src`; `*this` acts as if destructed; `src` becomes as-if default-cted (therefore in NULL state).</span></div>
<div class="line"><a id="l00432" name="l00432"></a><span class="lineno">  432</span><span class="comment">   * No-op if `&amp;src == this`.</span></div>
<div class="line"><a id="l00433" name="l00433"></a><span class="lineno">  433</span><span class="comment">   * Implements Native_handle_sender *and* Native_handle_receiver APIs at the same time, per their concept contracts.</span></div>
<div class="line"><a id="l00434" name="l00434"></a><span class="lineno">  434</span><span class="comment">   * (Also implements Blob_sender *and* Blob_receiver APIs; they are identical.)</span></div>
<div class="line"><a id="l00435" name="l00435"></a><span class="lineno">  435</span><span class="comment">   *</span></div>
<div class="line"><a id="l00436" name="l00436"></a><span class="lineno">  436</span><span class="comment">   * @see ~Native_socket_stream().</span></div>
<div class="line"><a id="l00437" name="l00437"></a><span class="lineno">  437</span><span class="comment">   *</span></div>
<div class="line"><a id="l00438" name="l00438"></a><span class="lineno">  438</span><span class="comment">   * @param src</span></div>
<div class="line"><a id="l00439" name="l00439"></a><span class="lineno">  439</span><span class="comment">   *        See above.</span></div>
<div class="line"><a id="l00440" name="l00440"></a><span class="lineno">  440</span><span class="comment">   * @return `*this` (see concept API).</span></div>
<div class="line"><a id="l00441" name="l00441"></a><span class="lineno">  441</span><span class="comment">   *</span></div>
<div class="line"><a id="l00442" name="l00442"></a><span class="lineno">  442</span><span class="comment">   * @see Native_handle_sender move assignment: implemented concept.</span></div>
<div class="line"><a id="l00443" name="l00443"></a><span class="lineno">  443</span><span class="comment">   * @see Native_handle_receiver move assignment: implemented concept.</span></div>
<div class="line"><a id="l00444" name="l00444"></a><span class="lineno">  444</span><span class="comment">   * @see Blob_sender move assignment: implemented concept.</span></div>
<div class="line"><a id="l00445" name="l00445"></a><span class="lineno">  445</span><span class="comment">   * @see Blob_receiver move assignment: implemented concept.</span></div>
<div class="line"><a id="l00446" name="l00446"></a><span class="lineno">  446</span><span class="comment">   */</span></div>
<div class="line"><a id="l00447" name="l00447"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1Native__socket__stream.html#afa23616d048eef3649bd20a2385af4c5">  447</a></span>  <a class="code hl_class" href="classipc_1_1transport_1_1Native__socket__stream.html">Native_socket_stream</a>&amp; <a class="code hl_function" href="classipc_1_1transport_1_1Native__socket__stream.html#afa23616d048eef3649bd20a2385af4c5">operator=</a>(<a class="code hl_class" href="classipc_1_1transport_1_1Native__socket__stream.html">Native_socket_stream</a>&amp;&amp; src);</div>
<div class="line"><a id="l00448" name="l00448"></a><span class="lineno">  448</span><span class="comment"></span> </div>
<div class="line"><a id="l00449" name="l00449"></a><span class="lineno">  449</span><span class="comment">  /// Copy assignment is disallowed.</span></div>
<div class="line"><a id="l00450" name="l00450"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1Native__socket__stream.html#a11715d6bc6844d1189ff694344bc343a">  450</a></span><span class="comment"></span>  <a class="code hl_class" href="classipc_1_1transport_1_1Native__socket__stream.html">Native_socket_stream</a>&amp; <a class="code hl_function" href="classipc_1_1transport_1_1Native__socket__stream.html#a11715d6bc6844d1189ff694344bc343a">operator=</a>(<span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1transport_1_1Native__socket__stream.html">Native_socket_stream</a>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00451" name="l00451"></a><span class="lineno">  451</span><span class="comment"></span> </div>
<div class="line"><a id="l00452" name="l00452"></a><span class="lineno">  452</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00453" name="l00453"></a><span class="lineno">  453</span><span class="comment">   * Returns nickname, a brief string suitable for logging.  This is included in the output by the `ostream&lt;&lt;`</span></div>
<div class="line"><a id="l00454" name="l00454"></a><span class="lineno">  454</span><span class="comment">   * operator as well.  This method is thread-safe in that it always returns the same value.</span></div>
<div class="line"><a id="l00455" name="l00455"></a><span class="lineno">  455</span><span class="comment">   *</span></div>
<div class="line"><a id="l00456" name="l00456"></a><span class="lineno">  456</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00457" name="l00457"></a><span class="lineno">  457</span><span class="comment">   */</span></div>
<div class="line"><a id="l00458" name="l00458"></a><span class="lineno">  458</span>  <span class="keyword">const</span> std::string&amp; <a class="code hl_function" href="classipc_1_1transport_1_1Native__socket__stream.html#a25d9c0e12a03a3b68f7f266c23466f71">nickname</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00459" name="l00459"></a><span class="lineno">  459</span> </div>
<div class="line"><a id="l00460" name="l00460"></a><span class="lineno">  460</span>  <span class="comment">// Connect-ops API.</span></div>
<div class="line"><a id="l00461" name="l00461"></a><span class="lineno">  461</span><span class="comment"></span> </div>
<div class="line"><a id="l00462" name="l00462"></a><span class="lineno">  462</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00463" name="l00463"></a><span class="lineno">  463</span><span class="comment">   * To be invoked in NULL state only, it synchronously and non-blockingly attempts to connect to an opposing</span></div>
<div class="line"><a id="l00464" name="l00464"></a><span class="lineno">  464</span><span class="comment">   * Native_socket_stream_acceptor or sync_io::Native_socket_stream_acceptor</span></div>
<div class="line"><a id="l00465" name="l00465"></a><span class="lineno">  465</span><span class="comment">   * listening at the given absolute Shared_name; and synchronously reports failure or success, the latter</span></div>
<div class="line"><a id="l00466" name="l00466"></a><span class="lineno">  466</span><span class="comment">   * showing `*this` has entered PEER state.  Failure means `*this` remains in NULL state.</span></div>
<div class="line"><a id="l00467" name="l00467"></a><span class="lineno">  467</span><span class="comment">   *</span></div>
<div class="line"><a id="l00468" name="l00468"></a><span class="lineno">  468</span><span class="comment">   * If invoked outside of NULL state this returns `false` and otherwise does nothing.</span></div>
<div class="line"><a id="l00469" name="l00469"></a><span class="lineno">  469</span><span class="comment">   *</span></div>
<div class="line"><a id="l00470" name="l00470"></a><span class="lineno">  470</span><span class="comment">   * Note that `*this` (modulo moves) that has entered PEER state can never change state subsequently</span></div>
<div class="line"><a id="l00471" name="l00471"></a><span class="lineno">  471</span><span class="comment">   * (even on transmission error); once a PEER, always a PEER.</span></div>
<div class="line"><a id="l00472" name="l00472"></a><span class="lineno">  472</span><span class="comment">   *</span></div>
<div class="line"><a id="l00473" name="l00473"></a><span class="lineno">  473</span><span class="comment">   * #Error_code generated and passed to `on_done_func()`:</span></div>
<div class="line"><a id="l00474" name="l00474"></a><span class="lineno">  474</span><span class="comment">   * system codes most likely from `boost::asio::error` or `boost::system::errc` (but never would-block).</span></div>
<div class="line"><a id="l00475" name="l00475"></a><span class="lineno">  475</span><span class="comment">   *</span></div>
<div class="line"><a id="l00476" name="l00476"></a><span class="lineno">  476</span><span class="comment">   * @see Class doc header, section &quot;Why no async-connect method, only sync-connect?&quot; for potentially interesting</span></div>
<div class="line"><a id="l00477" name="l00477"></a><span class="lineno">  477</span><span class="comment">   *      context.</span></div>
<div class="line"><a id="l00478" name="l00478"></a><span class="lineno">  478</span><span class="comment">   *</span></div>
<div class="line"><a id="l00479" name="l00479"></a><span class="lineno">  479</span><span class="comment">   * @return `false` if and only if invoked outside of NULL state (that is: in PEER state).</span></div>
<div class="line"><a id="l00480" name="l00480"></a><span class="lineno">  480</span><span class="comment">   *</span></div>
<div class="line"><a id="l00481" name="l00481"></a><span class="lineno">  481</span><span class="comment">   * @param absolute_name</span></div>
<div class="line"><a id="l00482" name="l00482"></a><span class="lineno">  482</span><span class="comment">   *        Absolute name at which the `Native_socket_stream_acceptor` is expected to be listening.</span></div>
<div class="line"><a id="l00483" name="l00483"></a><span class="lineno">  483</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00484" name="l00484"></a><span class="lineno">  484</span><span class="comment">   *        See `flow::Error_code` docs for error reporting semantics.  #Error_code generated:</span></div>
<div class="line"><a id="l00485" name="l00485"></a><span class="lineno">  485</span><span class="comment">   *        system codes most likely from `boost::asio::error` or `boost::system::errc` (but never would-block).</span></div>
<div class="line"><a id="l00486" name="l00486"></a><span class="lineno">  486</span><span class="comment">   */</span></div>
<div class="line"><a id="l00487" name="l00487"></a><span class="lineno">  487</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1transport_1_1Native__socket__stream.html#a89d591db714e83dcb55a52738fed1ebb">sync_connect</a>(<span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a>&amp; absolute_name, <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* err_code = 0);</div>
<div class="line"><a id="l00488" name="l00488"></a><span class="lineno">  488</span> </div>
<div class="line"><a id="l00489" name="l00489"></a><span class="lineno">  489</span>  <span class="comment">// Send-ops API.</span></div>
<div class="line"><a id="l00490" name="l00490"></a><span class="lineno">  490</span><span class="comment"></span> </div>
<div class="line"><a id="l00491" name="l00491"></a><span class="lineno">  491</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00492" name="l00492"></a><span class="lineno">  492</span><span class="comment">   * Implements Native_handle_sender API per contract.  Note this value equals send_blob_max_size() at any given</span></div>
<div class="line"><a id="l00493" name="l00493"></a><span class="lineno">  493</span><span class="comment">   * time which is *not* a concept requirement.  Its PEER-state constant value can also be accessed as</span></div>
<div class="line"><a id="l00494" name="l00494"></a><span class="lineno">  494</span><span class="comment">   * non-concept-mandated Native_socket_stream::S_MAX_META_BLOB_LENGTH.</span></div>
<div class="line"><a id="l00495" name="l00495"></a><span class="lineno">  495</span><span class="comment">   *</span></div>
<div class="line"><a id="l00496" name="l00496"></a><span class="lineno">  496</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00497" name="l00497"></a><span class="lineno">  497</span><span class="comment">   *</span></div>
<div class="line"><a id="l00498" name="l00498"></a><span class="lineno">  498</span><span class="comment">   * @see Native_handle_sender::send_meta_blob_max_size(): implemented concept.</span></div>
<div class="line"><a id="l00499" name="l00499"></a><span class="lineno">  499</span><span class="comment">   */</span></div>
<div class="line"><a id="l00500" name="l00500"></a><span class="lineno">  500</span>  <span class="keywordtype">size_t</span> <a class="code hl_function" href="classipc_1_1transport_1_1Native__socket__stream.html#a844b8245c9341da8006f979c6b005893">send_meta_blob_max_size</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00501" name="l00501"></a><span class="lineno">  501</span><span class="comment"></span> </div>
<div class="line"><a id="l00502" name="l00502"></a><span class="lineno">  502</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00503" name="l00503"></a><span class="lineno">  503</span><span class="comment">   * Implements Blob_sender API per contract.  Note this value equals send_meta_blob_max_size() at any given</span></div>
<div class="line"><a id="l00504" name="l00504"></a><span class="lineno">  504</span><span class="comment">   * time which is *not* a concept requirement.  Its PEER-state constant value can also be accessed as</span></div>
<div class="line"><a id="l00505" name="l00505"></a><span class="lineno">  505</span><span class="comment">   * non-concept-mandated Native_socket_stream::S_MAX_META_BLOB_LENGTH.</span></div>
<div class="line"><a id="l00506" name="l00506"></a><span class="lineno">  506</span><span class="comment">   *</span></div>
<div class="line"><a id="l00507" name="l00507"></a><span class="lineno">  507</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00508" name="l00508"></a><span class="lineno">  508</span><span class="comment">   *</span></div>
<div class="line"><a id="l00509" name="l00509"></a><span class="lineno">  509</span><span class="comment">   * @see Blob_sender::send_blob_max_size(): implemented concept.</span></div>
<div class="line"><a id="l00510" name="l00510"></a><span class="lineno">  510</span><span class="comment">   */</span></div>
<div class="line"><a id="l00511" name="l00511"></a><span class="lineno">  511</span>  <span class="keywordtype">size_t</span> <a class="code hl_function" href="classipc_1_1transport_1_1Native__socket__stream.html#a127a462a4aaf6e5cf1e42bdd33f51693">send_blob_max_size</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00512" name="l00512"></a><span class="lineno">  512</span><span class="comment"></span> </div>
<div class="line"><a id="l00513" name="l00513"></a><span class="lineno">  513</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00514" name="l00514"></a><span class="lineno">  514</span><span class="comment">   * Implements Native_handle_sender API per contract.  Reminder: You may call this directly from within a</span></div>
<div class="line"><a id="l00515" name="l00515"></a><span class="lineno">  515</span><span class="comment">   * completion handler you supplied to an earlier async_receive_native_handle().  Reminder: It&#39;s not thread-safe</span></div>
<div class="line"><a id="l00516" name="l00516"></a><span class="lineno">  516</span><span class="comment">   * to call this concurrently with other transmission methods or destructor on the same `*this`.</span></div>
<div class="line"><a id="l00517" name="l00517"></a><span class="lineno">  517</span><span class="comment">   *</span></div>
<div class="line"><a id="l00518" name="l00518"></a><span class="lineno">  518</span><span class="comment">   * @param hndl_or_null</span></div>
<div class="line"><a id="l00519" name="l00519"></a><span class="lineno">  519</span><span class="comment">   *        See above.</span></div>
<div class="line"><a id="l00520" name="l00520"></a><span class="lineno">  520</span><span class="comment">   * @param meta_blob</span></div>
<div class="line"><a id="l00521" name="l00521"></a><span class="lineno">  521</span><span class="comment">   *        See above.  Reminder: The memory area described by this arg need only be valid until this</span></div>
<div class="line"><a id="l00522" name="l00522"></a><span class="lineno">  522</span><span class="comment">   *        method returns.  Perf reminder: That area will not be copied except for very rare circumstances.</span></div>
<div class="line"><a id="l00523" name="l00523"></a><span class="lineno">  523</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00524" name="l00524"></a><span class="lineno">  524</span><span class="comment">   *        See above.  Reminder: In rare circumstances, an error emitted here may represent something</span></div>
<div class="line"><a id="l00525" name="l00525"></a><span class="lineno">  525</span><span class="comment">   *        detected during handling of a *preceding* send_native_handle() call but after it returned.</span></div>
<div class="line"><a id="l00526" name="l00526"></a><span class="lineno">  526</span><span class="comment">   *        #Error_code generated:</span></div>
<div class="line"><a id="l00527" name="l00527"></a><span class="lineno">  527</span><span class="comment">   *        error::Code::S_INVALID_ARGUMENT (non-pipe-hosing error: `meta_blob.size()` exceeds</span></div>
<div class="line"><a id="l00528" name="l00528"></a><span class="lineno">  528</span><span class="comment">   *        send_meta_blob_max_size()),</span></div>
<div class="line"><a id="l00529" name="l00529"></a><span class="lineno">  529</span><span class="comment">   *        error::Code::S_SENDS_FINISHED_CANNOT_SEND (`*end_sending()` was called earlier),</span></div>
<div class="line"><a id="l00530" name="l00530"></a><span class="lineno">  530</span><span class="comment">   *        error::Code::S_LOW_LVL_TRANSPORT_HOSED_CANNOT_SEND (the incoming-direction processing detected</span></div>
<div class="line"><a id="l00531" name="l00531"></a><span class="lineno">  531</span><span class="comment">   *        that the underlying transport is hosed; specific code was logged and can be obtained via</span></div>
<div class="line"><a id="l00532" name="l00532"></a><span class="lineno">  532</span><span class="comment">   *        async_receive_native_handle()),</span></div>
<div class="line"><a id="l00533" name="l00533"></a><span class="lineno">  533</span><span class="comment">   *        `boost::asio::error::eof` (underlying transport hosed due to graceful closing by the other side),</span></div>
<div class="line"><a id="l00534" name="l00534"></a><span class="lineno">  534</span><span class="comment">   *        other system codes most likely from `boost::asio::error` or `boost::system::errc` (but never</span></div>
<div class="line"><a id="l00535" name="l00535"></a><span class="lineno">  535</span><span class="comment">   *        would-block), indicating the underlying transport is hosed for that specific reason, as detected during</span></div>
<div class="line"><a id="l00536" name="l00536"></a><span class="lineno">  536</span><span class="comment">   *        outgoing-direction processing.</span></div>
<div class="line"><a id="l00537" name="l00537"></a><span class="lineno">  537</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00538" name="l00538"></a><span class="lineno">  538</span><span class="comment">   *</span></div>
<div class="line"><a id="l00539" name="l00539"></a><span class="lineno">  539</span><span class="comment">   * @see Native_handle_sender::send_native_handle(): implemented concept.</span></div>
<div class="line"><a id="l00540" name="l00540"></a><span class="lineno">  540</span><span class="comment">   */</span></div>
<div class="line"><a id="l00541" name="l00541"></a><span class="lineno">  541</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1transport_1_1Native__socket__stream.html#a555df6a81654160285ea35b545cfd23d">send_native_handle</a>(<a class="code hl_struct" href="structipc_1_1util_1_1Native__handle.html">Native_handle</a> hndl_or_null, <span class="keyword">const</span> <a class="code hl_typedef" href="namespaceipc_1_1util.html#ae0be7edba7e30ffa3f8b742af621f2ab">util::Blob_const</a>&amp; meta_blob,</div>
<div class="line"><a id="l00542" name="l00542"></a><span class="lineno">  542</span>                          <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* err_code = 0);</div>
<div class="line"><a id="l00543" name="l00543"></a><span class="lineno">  543</span><span class="comment"></span> </div>
<div class="line"><a id="l00544" name="l00544"></a><span class="lineno">  544</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00545" name="l00545"></a><span class="lineno">  545</span><span class="comment">   * Implements Blob_sender API per contract.  Reminder: You may call this directly from within a</span></div>
<div class="line"><a id="l00546" name="l00546"></a><span class="lineno">  546</span><span class="comment">   * completion handler you supplied to an earlier async_receive_blob().  Reminder: It&#39;s not thread-safe</span></div>
<div class="line"><a id="l00547" name="l00547"></a><span class="lineno">  547</span><span class="comment">   * to call this concurrently with other transmission methods or destructor on the same `*this`.</span></div>
<div class="line"><a id="l00548" name="l00548"></a><span class="lineno">  548</span><span class="comment">   *</span></div>
<div class="line"><a id="l00549" name="l00549"></a><span class="lineno">  549</span><span class="comment">   * Reminder: `blob.size() == 0` results in undefined behavior (assertion may trip).</span></div>
<div class="line"><a id="l00550" name="l00550"></a><span class="lineno">  550</span><span class="comment">   *</span></div>
<div class="line"><a id="l00551" name="l00551"></a><span class="lineno">  551</span><span class="comment">   * @param blob</span></div>
<div class="line"><a id="l00552" name="l00552"></a><span class="lineno">  552</span><span class="comment">   *        See above.  Reminder: The memory area described by this arg need only be valid until this</span></div>
<div class="line"><a id="l00553" name="l00553"></a><span class="lineno">  553</span><span class="comment">   *        method returns.  Perf reminder: That area will not be copied except for very rare circumstances.</span></div>
<div class="line"><a id="l00554" name="l00554"></a><span class="lineno">  554</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00555" name="l00555"></a><span class="lineno">  555</span><span class="comment">   *        See above.  Reminder: In rare circumstances, an error emitted here may represent something</span></div>
<div class="line"><a id="l00556" name="l00556"></a><span class="lineno">  556</span><span class="comment">   *        detected during handling of a *preceding* send_blob() call but after it returned.</span></div>
<div class="line"><a id="l00557" name="l00557"></a><span class="lineno">  557</span><span class="comment">   *        #Error_code generated: see send_native_handle().</span></div>
<div class="line"><a id="l00558" name="l00558"></a><span class="lineno">  558</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00559" name="l00559"></a><span class="lineno">  559</span><span class="comment">   *</span></div>
<div class="line"><a id="l00560" name="l00560"></a><span class="lineno">  560</span><span class="comment">   * @see Blob_sender::send_blob(): implemented concept.</span></div>
<div class="line"><a id="l00561" name="l00561"></a><span class="lineno">  561</span><span class="comment">   */</span></div>
<div class="line"><a id="l00562" name="l00562"></a><span class="lineno">  562</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1transport_1_1Native__socket__stream.html#a415febd76ee222c81d59d2bcfa9c01bc">send_blob</a>(<span class="keyword">const</span> <a class="code hl_typedef" href="namespaceipc_1_1util.html#ae0be7edba7e30ffa3f8b742af621f2ab">util::Blob_const</a>&amp; blob, <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* err_code = 0);</div>
<div class="line"><a id="l00563" name="l00563"></a><span class="lineno">  563</span><span class="comment"></span> </div>
<div class="line"><a id="l00564" name="l00564"></a><span class="lineno">  564</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00565" name="l00565"></a><span class="lineno">  565</span><span class="comment">   * Implements Native_handle_sender, Blob_sender API per contract.  Reminder: You may call this directly from within a</span></div>
<div class="line"><a id="l00566" name="l00566"></a><span class="lineno">  566</span><span class="comment">   * completion handler you supplied to an earlier async_receive_native_handle() or async_receive_blob().</span></div>
<div class="line"><a id="l00567" name="l00567"></a><span class="lineno">  567</span><span class="comment">   * Reminder: It&#39;s not thread-safe to call this concurrently with other transmission methods or destructor on</span></div>
<div class="line"><a id="l00568" name="l00568"></a><span class="lineno">  568</span><span class="comment">   * the same `*this`.</span></div>
<div class="line"><a id="l00569" name="l00569"></a><span class="lineno">  569</span><span class="comment">   *</span></div>
<div class="line"><a id="l00570" name="l00570"></a><span class="lineno">  570</span><span class="comment">   * #Error_code generated and passed to `on_done_func()`:</span></div>
<div class="line"><a id="l00571" name="l00571"></a><span class="lineno">  571</span><span class="comment">   * error::Code::S_LOW_LVL_TRANSPORT_HOSED_CANNOT_SEND (same meaning as for send_native_handle()/send_blob()),</span></div>
<div class="line"><a id="l00572" name="l00572"></a><span class="lineno">  572</span><span class="comment">   * `boost::asio::error::eof` (ditto),</span></div>
<div class="line"><a id="l00573" name="l00573"></a><span class="lineno">  573</span><span class="comment">   * other system codes most likely from `boost::asio::error` or `boost::system::errc` (ditto),</span></div>
<div class="line"><a id="l00574" name="l00574"></a><span class="lineno">  574</span><span class="comment">   * error::Code::S_OBJECT_SHUTDOWN_ABORTED_COMPLETION_HANDLER (destructor called, canceling all pending ops;</span></div>
<div class="line"><a id="l00575" name="l00575"></a><span class="lineno">  575</span><span class="comment">   * spiritually identical to `boost::asio::error::operation_aborted`),</span></div>
<div class="line"><a id="l00576" name="l00576"></a><span class="lineno">  576</span><span class="comment">   *</span></div>
<div class="line"><a id="l00577" name="l00577"></a><span class="lineno">  577</span><span class="comment">   * Reminder: In rare circumstances, an error emitted there may represent something</span></div>
<div class="line"><a id="l00578" name="l00578"></a><span class="lineno">  578</span><span class="comment">   * detected during handling of a preceding send_native_handle() or send_blob() call but after it returned.</span></div>
<div class="line"><a id="l00579" name="l00579"></a><span class="lineno">  579</span><span class="comment">   *</span></div>
<div class="line"><a id="l00580" name="l00580"></a><span class="lineno">  580</span><span class="comment">   * @tparam Task_err</span></div>
<div class="line"><a id="l00581" name="l00581"></a><span class="lineno">  581</span><span class="comment">   *         See above.</span></div>
<div class="line"><a id="l00582" name="l00582"></a><span class="lineno">  582</span><span class="comment">   * @param on_done_func</span></div>
<div class="line"><a id="l00583" name="l00583"></a><span class="lineno">  583</span><span class="comment">   *        See above.</span></div>
<div class="line"><a id="l00584" name="l00584"></a><span class="lineno">  584</span><span class="comment">   * @return See above.  Reminder: If and only if it returns `false`, we&#39;re not in PEER state, or `*end_sending()` has</span></div>
<div class="line"><a id="l00585" name="l00585"></a><span class="lineno">  585</span><span class="comment">   *         already been called; and `on_done_func()` will never be called, nor will an error be emitted.</span></div>
<div class="line"><a id="l00586" name="l00586"></a><span class="lineno">  586</span><span class="comment">   *</span></div>
<div class="line"><a id="l00587" name="l00587"></a><span class="lineno">  587</span><span class="comment">   * @see Native_handle_sender::async_end_sending(): implemented concept.</span></div>
<div class="line"><a id="l00588" name="l00588"></a><span class="lineno">  588</span><span class="comment">   * @see Blob_sender::async_end_sending(): alternatively implemented concept.</span></div>
<div class="line"><a id="l00589" name="l00589"></a><span class="lineno">  589</span><span class="comment">   */</span></div>
<div class="line"><a id="l00590" name="l00590"></a><span class="lineno">  590</span>  <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Task_err&gt;</div>
<div class="line"><a id="l00591" name="l00591"></a><span class="lineno">  591</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1transport_1_1Native__socket__stream.html#ac3cd00ddd2e0502677630320708277a3">async_end_sending</a>(Task_err&amp;&amp; on_done_func);</div>
<div class="line"><a id="l00592" name="l00592"></a><span class="lineno">  592</span><span class="comment"></span> </div>
<div class="line"><a id="l00593" name="l00593"></a><span class="lineno">  593</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00594" name="l00594"></a><span class="lineno">  594</span><span class="comment">   * Implements Native_handle_sender, Blob_sender API per contract.  Reminder: It is equivalent to async_end_sending()</span></div>
<div class="line"><a id="l00595" name="l00595"></a><span class="lineno">  595</span><span class="comment">   * but with a no-op `on_done_func`.</span></div>
<div class="line"><a id="l00596" name="l00596"></a><span class="lineno">  596</span><span class="comment">   *</span></div>
<div class="line"><a id="l00597" name="l00597"></a><span class="lineno">  597</span><span class="comment">   * @return See async_end_sending().</span></div>
<div class="line"><a id="l00598" name="l00598"></a><span class="lineno">  598</span><span class="comment">   *</span></div>
<div class="line"><a id="l00599" name="l00599"></a><span class="lineno">  599</span><span class="comment">   * @see Native_handle_sender::end_sending(): implemented concept.</span></div>
<div class="line"><a id="l00600" name="l00600"></a><span class="lineno">  600</span><span class="comment">   * @see Blob_sender::end_sending(): alternatively implemented concept.</span></div>
<div class="line"><a id="l00601" name="l00601"></a><span class="lineno">  601</span><span class="comment">   */</span></div>
<div class="line"><a id="l00602" name="l00602"></a><span class="lineno">  602</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1transport_1_1Native__socket__stream.html#ace134e4a6e4918212f256b60c3ed77e4">end_sending</a>();</div>
<div class="line"><a id="l00603" name="l00603"></a><span class="lineno">  603</span><span class="comment"></span> </div>
<div class="line"><a id="l00604" name="l00604"></a><span class="lineno">  604</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00605" name="l00605"></a><span class="lineno">  605</span><span class="comment">   * Implements Native_handle_sender, Blob_sender API per contract.</span></div>
<div class="line"><a id="l00606" name="l00606"></a><span class="lineno">  606</span><span class="comment">   *</span></div>
<div class="line"><a id="l00607" name="l00607"></a><span class="lineno">  607</span><span class="comment">   * @param period</span></div>
<div class="line"><a id="l00608" name="l00608"></a><span class="lineno">  608</span><span class="comment">   *        See above.</span></div>
<div class="line"><a id="l00609" name="l00609"></a><span class="lineno">  609</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00610" name="l00610"></a><span class="lineno">  610</span><span class="comment">   *</span></div>
<div class="line"><a id="l00611" name="l00611"></a><span class="lineno">  611</span><span class="comment">   * @see Native_handle_sender::auto_ping(): implemented concept.</span></div>
<div class="line"><a id="l00612" name="l00612"></a><span class="lineno">  612</span><span class="comment">   * @see Blob_sender::auto_ping(): alternatively implemented concept.</span></div>
<div class="line"><a id="l00613" name="l00613"></a><span class="lineno">  613</span><span class="comment">   */</span></div>
<div class="line"><a id="l00614" name="l00614"></a><span class="lineno">  614</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1transport_1_1Native__socket__stream.html#aa5e699d5eead4220bf8b5604f629a970">auto_ping</a>(<a class="code hl_typedef" href="namespaceipc_1_1util.html#ac66141280c3b7295a86b65209f31cc58">util::Fine_duration</a> period = boost::chrono::seconds(2));</div>
<div class="line"><a id="l00615" name="l00615"></a><span class="lineno">  615</span> </div>
<div class="line"><a id="l00616" name="l00616"></a><span class="lineno">  616</span>  <span class="comment">// Receive-ops API.</span></div>
<div class="line"><a id="l00617" name="l00617"></a><span class="lineno">  617</span><span class="comment"></span> </div>
<div class="line"><a id="l00618" name="l00618"></a><span class="lineno">  618</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00619" name="l00619"></a><span class="lineno">  619</span><span class="comment">   * Implements Native_handle_receiver API per contract.  Note this value equals receive_blob_max_size() at any given</span></div>
<div class="line"><a id="l00620" name="l00620"></a><span class="lineno">  620</span><span class="comment">   * time which is *not* a concept requirement.</span></div>
<div class="line"><a id="l00621" name="l00621"></a><span class="lineno">  621</span><span class="comment">   *</span></div>
<div class="line"><a id="l00622" name="l00622"></a><span class="lineno">  622</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00623" name="l00623"></a><span class="lineno">  623</span><span class="comment">   *</span></div>
<div class="line"><a id="l00624" name="l00624"></a><span class="lineno">  624</span><span class="comment">   * @see Native_handle_receiver::receive_meta_blob_max_size(): implemented concept.</span></div>
<div class="line"><a id="l00625" name="l00625"></a><span class="lineno">  625</span><span class="comment">   */</span></div>
<div class="line"><a id="l00626" name="l00626"></a><span class="lineno">  626</span>  <span class="keywordtype">size_t</span> <a class="code hl_function" href="classipc_1_1transport_1_1Native__socket__stream.html#ac7659af6812efca67c410af286f0cb34">receive_meta_blob_max_size</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00627" name="l00627"></a><span class="lineno">  627</span><span class="comment"></span> </div>
<div class="line"><a id="l00628" name="l00628"></a><span class="lineno">  628</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00629" name="l00629"></a><span class="lineno">  629</span><span class="comment">   * Implements Blob_receiver API per contract.  Note this value equals receive_meta_blob_max_size() at any given</span></div>
<div class="line"><a id="l00630" name="l00630"></a><span class="lineno">  630</span><span class="comment">   * time which is *not* a concept requirement.</span></div>
<div class="line"><a id="l00631" name="l00631"></a><span class="lineno">  631</span><span class="comment">   *</span></div>
<div class="line"><a id="l00632" name="l00632"></a><span class="lineno">  632</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00633" name="l00633"></a><span class="lineno">  633</span><span class="comment">   *</span></div>
<div class="line"><a id="l00634" name="l00634"></a><span class="lineno">  634</span><span class="comment">   * @see Blob_receiver::receive_blob_max_size(): implemented concept.</span></div>
<div class="line"><a id="l00635" name="l00635"></a><span class="lineno">  635</span><span class="comment">   */</span></div>
<div class="line"><a id="l00636" name="l00636"></a><span class="lineno">  636</span>  <span class="keywordtype">size_t</span> <a class="code hl_function" href="classipc_1_1transport_1_1Native__socket__stream.html#adb667160fd0ab3951d93d219d7bdc3be">receive_blob_max_size</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00637" name="l00637"></a><span class="lineno">  637</span><span class="comment"></span> </div>
<div class="line"><a id="l00638" name="l00638"></a><span class="lineno">  638</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00639" name="l00639"></a><span class="lineno">  639</span><span class="comment">   * Implements Native_handle_receiver API per contract.  Reminder: You may call this directly from within a</span></div>
<div class="line"><a id="l00640" name="l00640"></a><span class="lineno">  640</span><span class="comment">   * completion handler you supplied to an earlier async_receive_native_handle().  Reminder: It&#39;s not thread-safe</span></div>
<div class="line"><a id="l00641" name="l00641"></a><span class="lineno">  641</span><span class="comment">   * to call this concurrently with other transmission methods or destructor on the same `*this`.</span></div>
<div class="line"><a id="l00642" name="l00642"></a><span class="lineno">  642</span><span class="comment">   *</span></div>
<div class="line"><a id="l00643" name="l00643"></a><span class="lineno">  643</span><span class="comment">   * #Error_code generated and passed to `on_done_func()`:</span></div>
<div class="line"><a id="l00644" name="l00644"></a><span class="lineno">  644</span><span class="comment">   * error::Code::S_OBJECT_SHUTDOWN_ABORTED_COMPLETION_HANDLER (destructor called, canceling all pending ops;</span></div>
<div class="line"><a id="l00645" name="l00645"></a><span class="lineno">  645</span><span class="comment">   * spiritually identical to `boost::asio::error::operation_aborted`),</span></div>
<div class="line"><a id="l00646" name="l00646"></a><span class="lineno">  646</span><span class="comment">   * error::Code::S_MESSAGE_SIZE_EXCEEDS_USER_STORAGE (opposing peer has sent a message with a meta-blob exceeding</span></div>
<div class="line"><a id="l00647" name="l00647"></a><span class="lineno">  647</span><span class="comment">   * `target_meta_blob.size()` in length; in particular one can give an empty buffer if no meta-blob expected),</span></div>
<div class="line"><a id="l00648" name="l00648"></a><span class="lineno">  648</span><span class="comment">   * error::Code::S_RECEIVES_FINISHED_CANNOT_RECEIVE (peer gracefully closed pipe via `*end_sending()`),</span></div>
<div class="line"><a id="l00649" name="l00649"></a><span class="lineno">  649</span><span class="comment">   * error::Code::S_LOW_LVL_TRANSPORT_HOSED_CANNOT_RECEIVE (the outgoing-direction processing detected</span></div>
<div class="line"><a id="l00650" name="l00650"></a><span class="lineno">  650</span><span class="comment">   * that the underlying transport is hosed; specific code was logged and can be obtained via send_native_handle()),</span></div>
<div class="line"><a id="l00651" name="l00651"></a><span class="lineno">  651</span><span class="comment">   * `boost::asio::error::eof` (underlying transport hosed due to graceful closing by the other side),</span></div>
<div class="line"><a id="l00652" name="l00652"></a><span class="lineno">  652</span><span class="comment">   * other system codes most likely from `boost::asio::error` or `boost::system::errc` (but never</span></div>
<div class="line"><a id="l00653" name="l00653"></a><span class="lineno">  653</span><span class="comment">   * would-block), indicating the underlying transport is hosed for that specific reason, as detected during</span></div>
<div class="line"><a id="l00654" name="l00654"></a><span class="lineno">  654</span><span class="comment">   * incoming-direction processing.</span></div>
<div class="line"><a id="l00655" name="l00655"></a><span class="lineno">  655</span><span class="comment">   *</span></div>
<div class="line"><a id="l00656" name="l00656"></a><span class="lineno">  656</span><span class="comment">   * error::Code::S_INVALID_ARGUMENT shall never be emitted due to `target_meta_blob.size()` (or as of this writing</span></div>
<div class="line"><a id="l00657" name="l00657"></a><span class="lineno">  657</span><span class="comment">   * for any other reason).  See #S_META_BLOB_UNDERFLOW_ALLOWED.</span></div>
<div class="line"><a id="l00658" name="l00658"></a><span class="lineno">  658</span><span class="comment">   *</span></div>
<div class="line"><a id="l00659" name="l00659"></a><span class="lineno">  659</span><span class="comment">   * @tparam Task_err_sz</span></div>
<div class="line"><a id="l00660" name="l00660"></a><span class="lineno">  660</span><span class="comment">   *         See above.</span></div>
<div class="line"><a id="l00661" name="l00661"></a><span class="lineno">  661</span><span class="comment">   * @param target_hndl</span></div>
<div class="line"><a id="l00662" name="l00662"></a><span class="lineno">  662</span><span class="comment">   *        See above.</span></div>
<div class="line"><a id="l00663" name="l00663"></a><span class="lineno">  663</span><span class="comment">   * @param target_meta_blob</span></div>
<div class="line"><a id="l00664" name="l00664"></a><span class="lineno">  664</span><span class="comment">   *        See above.  Reminder: The memory area described by this arg must be valid up to</span></div>
<div class="line"><a id="l00665" name="l00665"></a><span class="lineno">  665</span><span class="comment">   *        completion handler entry.</span></div>
<div class="line"><a id="l00666" name="l00666"></a><span class="lineno">  666</span><span class="comment">   * @param on_done_func</span></div>
<div class="line"><a id="l00667" name="l00667"></a><span class="lineno">  667</span><span class="comment">   *        See above.</span></div>
<div class="line"><a id="l00668" name="l00668"></a><span class="lineno">  668</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00669" name="l00669"></a><span class="lineno">  669</span><span class="comment">   *</span></div>
<div class="line"><a id="l00670" name="l00670"></a><span class="lineno">  670</span><span class="comment">   * @see Native_handle_receiver::async_receive_native_handle(): implemented concept.</span></div>
<div class="line"><a id="l00671" name="l00671"></a><span class="lineno">  671</span><span class="comment">   */</span></div>
<div class="line"><a id="l00672" name="l00672"></a><span class="lineno">  672</span>  <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Task_err_sz&gt;</div>
<div class="line"><a id="l00673" name="l00673"></a><span class="lineno">  673</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1transport_1_1Native__socket__stream.html#a266b52821557f2a4fa8f81058290dee2">async_receive_native_handle</a>(<a class="code hl_struct" href="structipc_1_1util_1_1Native__handle.html">Native_handle</a>* target_hndl, <span class="keyword">const</span> <a class="code hl_typedef" href="namespaceipc_1_1util.html#a6cb62ae434900f3a8915b33ec5d61a96">util::Blob_mutable</a>&amp; target_meta_blob,</div>
<div class="line"><a id="l00674" name="l00674"></a><span class="lineno">  674</span>                                   Task_err_sz&amp;&amp; on_done_func);</div>
<div class="line"><a id="l00675" name="l00675"></a><span class="lineno">  675</span><span class="comment"></span> </div>
<div class="line"><a id="l00676" name="l00676"></a><span class="lineno">  676</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00677" name="l00677"></a><span class="lineno">  677</span><span class="comment">   * Implements Blob_receiver API per contract.  Reminder: You may call this directly from within a</span></div>
<div class="line"><a id="l00678" name="l00678"></a><span class="lineno">  678</span><span class="comment">   * completion handler you supplied to an earlier async_receive_blob().  Reminder: It&#39;s not thread-safe</span></div>
<div class="line"><a id="l00679" name="l00679"></a><span class="lineno">  679</span><span class="comment">   * to call this concurrently with other transmission methods or destructor on the same `*this`.</span></div>
<div class="line"><a id="l00680" name="l00680"></a><span class="lineno">  680</span><span class="comment">   *</span></div>
<div class="line"><a id="l00681" name="l00681"></a><span class="lineno">  681</span><span class="comment">   * #Error_code generated and passed to `on_done_func()`: see async_receive_native_handle().</span></div>
<div class="line"><a id="l00682" name="l00682"></a><span class="lineno">  682</span><span class="comment">   * In addition: error::Code::S_BLOB_RECEIVER_GOT_NON_BLOB (opposing peer seems to have used a</span></div>
<div class="line"><a id="l00683" name="l00683"></a><span class="lineno">  683</span><span class="comment">   * Native_socket_stream::send_native_handle() call, which they shouldn&#39;t in the first place, and supplied</span></div>
<div class="line"><a id="l00684" name="l00684"></a><span class="lineno">  684</span><span class="comment">   * a non-null #Native_handle, which this Blob_receiver cannot accept).</span></div>
<div class="line"><a id="l00685" name="l00685"></a><span class="lineno">  685</span><span class="comment">   *</span></div>
<div class="line"><a id="l00686" name="l00686"></a><span class="lineno">  686</span><span class="comment">   * @tparam Task_err_sz</span></div>
<div class="line"><a id="l00687" name="l00687"></a><span class="lineno">  687</span><span class="comment">   *         See above.</span></div>
<div class="line"><a id="l00688" name="l00688"></a><span class="lineno">  688</span><span class="comment">   * @param target_blob</span></div>
<div class="line"><a id="l00689" name="l00689"></a><span class="lineno">  689</span><span class="comment">   *        See above.  Reminder: The memory area described by this arg must be valid up to</span></div>
<div class="line"><a id="l00690" name="l00690"></a><span class="lineno">  690</span><span class="comment">   *        completion handler entry.</span></div>
<div class="line"><a id="l00691" name="l00691"></a><span class="lineno">  691</span><span class="comment">   * @param on_done_func</span></div>
<div class="line"><a id="l00692" name="l00692"></a><span class="lineno">  692</span><span class="comment">   *        See above.</span></div>
<div class="line"><a id="l00693" name="l00693"></a><span class="lineno">  693</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00694" name="l00694"></a><span class="lineno">  694</span><span class="comment">   *</span></div>
<div class="line"><a id="l00695" name="l00695"></a><span class="lineno">  695</span><span class="comment">   * @see Blob_receiver::async_receive_blob(): implemented concept.</span></div>
<div class="line"><a id="l00696" name="l00696"></a><span class="lineno">  696</span><span class="comment">   */</span></div>
<div class="line"><a id="l00697" name="l00697"></a><span class="lineno">  697</span>  <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Task_err_sz&gt;</div>
<div class="line"><a id="l00698" name="l00698"></a><span class="lineno">  698</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1transport_1_1Native__socket__stream.html#ac5572c8165e25f106f18d327c07d1c3f">async_receive_blob</a>(<span class="keyword">const</span> <a class="code hl_typedef" href="namespaceipc_1_1util.html#a6cb62ae434900f3a8915b33ec5d61a96">util::Blob_mutable</a>&amp; target_blob, Task_err_sz&amp;&amp; on_done_func);</div>
<div class="line"><a id="l00699" name="l00699"></a><span class="lineno">  699</span><span class="comment"></span> </div>
<div class="line"><a id="l00700" name="l00700"></a><span class="lineno">  700</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00701" name="l00701"></a><span class="lineno">  701</span><span class="comment">   * Implements Native_handle_receiver, Blob_receiver API per contract.</span></div>
<div class="line"><a id="l00702" name="l00702"></a><span class="lineno">  702</span><span class="comment">   *</span></div>
<div class="line"><a id="l00703" name="l00703"></a><span class="lineno">  703</span><span class="comment">   * @param timeout</span></div>
<div class="line"><a id="l00704" name="l00704"></a><span class="lineno">  704</span><span class="comment">   *        See above.</span></div>
<div class="line"><a id="l00705" name="l00705"></a><span class="lineno">  705</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00706" name="l00706"></a><span class="lineno">  706</span><span class="comment">   *</span></div>
<div class="line"><a id="l00707" name="l00707"></a><span class="lineno">  707</span><span class="comment">   * @see Blob_receiver::idle_timer_run(): implemented concept.</span></div>
<div class="line"><a id="l00708" name="l00708"></a><span class="lineno">  708</span><span class="comment">   * @see Native_handle_receiver::idle_timer_run(): alternatively implemented concept.</span></div>
<div class="line"><a id="l00709" name="l00709"></a><span class="lineno">  709</span><span class="comment">   */</span></div>
<div class="line"><a id="l00710" name="l00710"></a><span class="lineno">  710</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1transport_1_1Native__socket__stream.html#a1b4ce3ddee39f21e752ec9114ac17bbd">idle_timer_run</a>(<a class="code hl_typedef" href="namespaceipc_1_1util.html#ac66141280c3b7295a86b65209f31cc58">util::Fine_duration</a> timeout = boost::chrono::seconds(5));</div>
<div class="line"><a id="l00711" name="l00711"></a><span class="lineno">  711</span> </div>
<div class="line"><a id="l00712" name="l00712"></a><span class="lineno">  712</span>  <span class="comment">// Misc API.</span></div>
<div class="line"><a id="l00713" name="l00713"></a><span class="lineno">  713</span><span class="comment"></span> </div>
<div class="line"><a id="l00714" name="l00714"></a><span class="lineno">  714</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00715" name="l00715"></a><span class="lineno">  715</span><span class="comment">   * OS-reported process credential (PID, etc.) info about the *other* connected peer&#39;s process, at the time</span></div>
<div class="line"><a id="l00716" name="l00716"></a><span class="lineno">  716</span><span class="comment">   * that the OS first established (via local-socket-connect or local-socket-connected-pair-generate call) that</span></div>
<div class="line"><a id="l00717" name="l00717"></a><span class="lineno">  717</span><span class="comment">   * opposing peer socket.  The value returned, assuming a non-error-emitting execution, shall always be the same for a</span></div>
<div class="line"><a id="l00718" name="l00718"></a><span class="lineno">  718</span><span class="comment">   * given `*this`.</span></div>
<div class="line"><a id="l00719" name="l00719"></a><span class="lineno">  719</span><span class="comment">   *</span></div>
<div class="line"><a id="l00720" name="l00720"></a><span class="lineno">  720</span><span class="comment">   * Informally: To avoid (though, formally, not guarantee) error::Code::S_LOW_LVL_TRANSPORT_HOSED, it is best</span></div>
<div class="line"><a id="l00721" name="l00721"></a><span class="lineno">  721</span><span class="comment">   * to call this immediately upon entry of `*this` to PEER state and/or before</span></div>
<div class="line"><a id="l00722" name="l00722"></a><span class="lineno">  722</span><span class="comment">   * invoking any other APIs.</span></div>
<div class="line"><a id="l00723" name="l00723"></a><span class="lineno">  723</span><span class="comment">   *</span></div>
<div class="line"><a id="l00724" name="l00724"></a><span class="lineno">  724</span><span class="comment">   * If invoked outside of PEER state returns `Process_credentials()` immediately</span></div>
<div class="line"><a id="l00725" name="l00725"></a><span class="lineno">  725</span><span class="comment">   * and otherwise does nothing.</span></div>
<div class="line"><a id="l00726" name="l00726"></a><span class="lineno">  726</span><span class="comment">   *</span></div>
<div class="line"><a id="l00727" name="l00727"></a><span class="lineno">  727</span><span class="comment">   * @return See above; or `Peer_credentials()` if invoked outside of PEER state or in case of error.</span></div>
<div class="line"><a id="l00728" name="l00728"></a><span class="lineno">  728</span><span class="comment">   *         The 2 eventualities can be distinguished by checking `*err_code` truthiness.  Better yet</span></div>
<div class="line"><a id="l00729" name="l00729"></a><span class="lineno">  729</span><span class="comment">   *         only call remote_peer_process_credentials() in PEER state, as it is otherwise conceptually meaningless.</span></div>
<div class="line"><a id="l00730" name="l00730"></a><span class="lineno">  730</span><span class="comment">   *</span></div>
<div class="line"><a id="l00731" name="l00731"></a><span class="lineno">  731</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00732" name="l00732"></a><span class="lineno">  732</span><span class="comment">   *        See `flow::Error_code` docs for error reporting semantics.  #Error_code generated:</span></div>
<div class="line"><a id="l00733" name="l00733"></a><span class="lineno">  733</span><span class="comment">   *        error::Code::S_LOW_LVL_TRANSPORT_HOSED (the incoming/outgoing-direction processing detected</span></div>
<div class="line"><a id="l00734" name="l00734"></a><span class="lineno">  734</span><span class="comment">   *        that the underlying transport is hosed; specific code was logged and can be obtained via</span></div>
<div class="line"><a id="l00735" name="l00735"></a><span class="lineno">  735</span><span class="comment">   *        async_receive_native_handle() or similar),</span></div>
<div class="line"><a id="l00736" name="l00736"></a><span class="lineno">  736</span><span class="comment">   *        system codes (albeit unlikely).</span></div>
<div class="line"><a id="l00737" name="l00737"></a><span class="lineno">  737</span><span class="comment">   */</span></div>
<div class="line"><a id="l00738" name="l00738"></a><span class="lineno">  738</span>  <a class="code hl_class" href="classipc_1_1util_1_1Process__credentials.html">util::Process_credentials</a> <a class="code hl_function" href="classipc_1_1transport_1_1Native__socket__stream.html#af63671c0e30d39d3460331c4dd3742b2">remote_peer_process_credentials</a>(<a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* err_code = 0) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00739" name="l00739"></a><span class="lineno">  739</span> </div>
<div class="line"><a id="l00740" name="l00740"></a><span class="lineno">  740</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00741" name="l00741"></a><span class="lineno">  741</span>  <span class="comment">// Types.</span></div>
<div class="line"><a id="l00742" name="l00742"></a><span class="lineno">  742</span> </div>
<div class="line"><a id="l00743" name="l00743"></a><span class="lineno">  743</span>  <span class="comment">// Forward declare the pImpl-idiom true implementation of this class.  See native_socket_stream_impl.hpp.</span></div>
<div class="line"><a id="l00744" name="l00744"></a><span class="lineno">  744</span>  <span class="keyword">class </span><a class="code hl_class" href="classipc_1_1transport_1_1Native__socket__stream_1_1Impl.html">Impl</a>;</div>
<div class="line"><a id="l00745" name="l00745"></a><span class="lineno">  745</span><span class="comment"></span> </div>
<div class="line"><a id="l00746" name="l00746"></a><span class="lineno">  746</span><span class="comment">  /// Short-hand for `const`-respecting wrapper around Native_socket_stream::Impl for the pImpl idiom.</span></div>
<div class="line"><a id="l00747" name="l00747"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1Native__socket__stream.html#ab93697ce64c2f2357d319ae2cdf7a1da">  747</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classipc_1_1transport_1_1Native__socket__stream.html#ab93697ce64c2f2357d319ae2cdf7a1da">Impl_ptr</a> = std::experimental::propagate_const&lt;boost::movelib::unique_ptr&lt;Impl&gt;&gt;;</div>
<div class="line"><a id="l00748" name="l00748"></a><span class="lineno">  748</span> </div>
<div class="line"><a id="l00749" name="l00749"></a><span class="lineno">  749</span>  <span class="comment">// Friends.</span></div>
<div class="line"><a id="l00750" name="l00750"></a><span class="lineno">  750</span><span class="comment"></span> </div>
<div class="line"><a id="l00751" name="l00751"></a><span class="lineno">  751</span><span class="comment">  /// Friend of Native_socket_stream.</span></div>
<div class="line"><a id="l00752" name="l00752"></a><span class="lineno">  752</span><span class="comment"></span>  <span class="keyword">friend</span> std::ostream&amp; <a class="code hl_friend" href="classipc_1_1transport_1_1Native__socket__stream.html#ac6108711cc8b33c3b7ef0491ba78e2f6">operator&lt;&lt;</a>(std::ostream&amp; os, <span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1transport_1_1Native__socket__stream.html">Native_socket_stream</a>&amp; val);<span class="comment"></span></div>
<div class="line"><a id="l00753" name="l00753"></a><span class="lineno">  753</span><span class="comment">  /// Friend of Native_socket_stream.</span></div>
<div class="line"><a id="l00754" name="l00754"></a><span class="lineno">  754</span><span class="comment"></span>  <span class="keyword">friend</span> std::ostream&amp; <a class="code hl_friend" href="classipc_1_1transport_1_1Native__socket__stream.html#ac6108711cc8b33c3b7ef0491ba78e2f6">operator&lt;&lt;</a>(std::ostream&amp; os, <span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1transport_1_1Native__socket__stream_1_1Impl.html">Impl</a>&amp; val);</div>
<div class="line"><a id="l00755" name="l00755"></a><span class="lineno">  755</span> </div>
<div class="line"><a id="l00756" name="l00756"></a><span class="lineno">  756</span>  <span class="comment">// Methods.</span></div>
<div class="line"><a id="l00757" name="l00757"></a><span class="lineno">  757</span><span class="comment"></span> </div>
<div class="line"><a id="l00758" name="l00758"></a><span class="lineno">  758</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00759" name="l00759"></a><span class="lineno">  759</span><span class="comment">   * Helper that simply returns #m_impl while guaranteeing that #m_impl is non-null upon return.  All</span></div>
<div class="line"><a id="l00760" name="l00760"></a><span class="lineno">  760</span><span class="comment">   * forwarding-to-#m_impl methods (including `const` ones) shall access #m_impl through this impl() method only.</span></div>
<div class="line"><a id="l00761" name="l00761"></a><span class="lineno">  761</span><span class="comment">   *</span></div>
<div class="line"><a id="l00762" name="l00762"></a><span class="lineno">  762</span><span class="comment">   * ### Design/rationale ###</span></div>
<div class="line"><a id="l00763" name="l00763"></a><span class="lineno">  763</span><span class="comment">   * It returns #m_impl... but if it is null, then it is first re-initialized to a new default-cted</span></div>
<div class="line"><a id="l00764" name="l00764"></a><span class="lineno">  764</span><span class="comment">   * Native_socket_stream::Impl.  That is:</span></div>
<div class="line"><a id="l00765" name="l00765"></a><span class="lineno">  765</span><span class="comment">   *   - Any ctor will make #m_impl non-null.</span></div>
<div class="line"><a id="l00766" name="l00766"></a><span class="lineno">  766</span><span class="comment">   *   - But moving-from `*this` will make #m_impl null.</span></div>
<div class="line"><a id="l00767" name="l00767"></a><span class="lineno">  767</span><span class="comment">   *   - However *if* the user were to invoke a public method of `*this` after the latter, then that public method</span></div>
<div class="line"><a id="l00768" name="l00768"></a><span class="lineno">  768</span><span class="comment">   *     shall invoke impl() which shall make #m_impl non-null again, which will ensure the public method works fine.</span></div>
<div class="line"><a id="l00769" name="l00769"></a><span class="lineno">  769</span><span class="comment">   *</span></div>
<div class="line"><a id="l00770" name="l00770"></a><span class="lineno">  770</span><span class="comment">   * Why?  Answer: This is the usual question of what to do with null m_impl (e.g., it&#39;s mentioned in cppreference.com</span></div>
<div class="line"><a id="l00771" name="l00771"></a><span class="lineno">  771</span><span class="comment">   * pImpl page) which occurs when one moves-from a given object.  There are various possibilities; but in our case we</span></div>
<div class="line"><a id="l00772" name="l00772"></a><span class="lineno">  772</span><span class="comment">   * do want to enable regular use of a moved-from object; hence we promised that a moved-from object is simply in</span></div>
<div class="line"><a id="l00773" name="l00773"></a><span class="lineno">  773</span><span class="comment">   * NULL (not-connected) state, as-if default-cted.  So we do that lazily (on-demand) on encountering</span></div>
<div class="line"><a id="l00774" name="l00774"></a><span class="lineno">  774</span><span class="comment">   * null m_impl.  Of course we could do it directly inside move ctor/assignment (non-lazily), but in many cases such</span></div>
<div class="line"><a id="l00775" name="l00775"></a><span class="lineno">  775</span><span class="comment">   * objects are abandoned in practice, so it&#39;s best not to start threads, etc., unless really desired.  The</span></div>
<div class="line"><a id="l00776" name="l00776"></a><span class="lineno">  776</span><span class="comment">   * null check cost is minor.</span></div>
<div class="line"><a id="l00777" name="l00777"></a><span class="lineno">  777</span><span class="comment">   *</span></div>
<div class="line"><a id="l00778" name="l00778"></a><span class="lineno">  778</span><span class="comment">   * Caveat: To be used by `const` methods this method must be `const`; but it must at times modify #m_impl</span></div>
<div class="line"><a id="l00779" name="l00779"></a><span class="lineno">  779</span><span class="comment">   * (the pointer... not the pointee).  For that reason #m_impl must be `mutable`.  That is fine: `mutable` for</span></div>
<div class="line"><a id="l00780" name="l00780"></a><span class="lineno">  780</span><span class="comment">   * lazy evaluation is a vanilla pattern.</span></div>
<div class="line"><a id="l00781" name="l00781"></a><span class="lineno">  781</span><span class="comment">   *</span></div>
<div class="line"><a id="l00782" name="l00782"></a><span class="lineno">  782</span><span class="comment">   * @return Reference to #m_impl.</span></div>
<div class="line"><a id="l00783" name="l00783"></a><span class="lineno">  783</span><span class="comment">   */</span></div>
<div class="line"><a id="l00784" name="l00784"></a><span class="lineno">  784</span>  <a class="code hl_typedef" href="classipc_1_1transport_1_1Native__socket__stream.html#ab93697ce64c2f2357d319ae2cdf7a1da">Impl_ptr</a>&amp; <a class="code hl_function" href="classipc_1_1transport_1_1Native__socket__stream.html#a0d0416ffe729877dad845e88c3609974">impl</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00785" name="l00785"></a><span class="lineno">  785</span><span class="comment"></span> </div>
<div class="line"><a id="l00786" name="l00786"></a><span class="lineno">  786</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00787" name="l00787"></a><span class="lineno">  787</span><span class="comment">   * Template-free version of async_end_sending() as required by pImpl idiom.</span></div>
<div class="line"><a id="l00788" name="l00788"></a><span class="lineno">  788</span><span class="comment">   *</span></div>
<div class="line"><a id="l00789" name="l00789"></a><span class="lineno">  789</span><span class="comment">   * @param on_done_func</span></div>
<div class="line"><a id="l00790" name="l00790"></a><span class="lineno">  790</span><span class="comment">   *        See async_end_sending().</span></div>
<div class="line"><a id="l00791" name="l00791"></a><span class="lineno">  791</span><span class="comment">   * @return See async_end_sending().</span></div>
<div class="line"><a id="l00792" name="l00792"></a><span class="lineno">  792</span><span class="comment">   */</span></div>
<div class="line"><a id="l00793" name="l00793"></a><span class="lineno">  793</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1transport_1_1Native__socket__stream.html#a949ab3296e29230518095d1f00f57a93">async_end_sending_fwd</a>(flow::async::Task_asio_err&amp;&amp; on_done_func);</div>
<div class="line"><a id="l00794" name="l00794"></a><span class="lineno">  794</span><span class="comment"></span> </div>
<div class="line"><a id="l00795" name="l00795"></a><span class="lineno">  795</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00796" name="l00796"></a><span class="lineno">  796</span><span class="comment">   * Template-free version of async_receive_native_handle() as required by pImpl idiom.</span></div>
<div class="line"><a id="l00797" name="l00797"></a><span class="lineno">  797</span><span class="comment">   *</span></div>
<div class="line"><a id="l00798" name="l00798"></a><span class="lineno">  798</span><span class="comment">   * @param target_hndl</span></div>
<div class="line"><a id="l00799" name="l00799"></a><span class="lineno">  799</span><span class="comment">   *        See async_receive_native_handle().</span></div>
<div class="line"><a id="l00800" name="l00800"></a><span class="lineno">  800</span><span class="comment">   * @param target_meta_blob</span></div>
<div class="line"><a id="l00801" name="l00801"></a><span class="lineno">  801</span><span class="comment">   *        See async_receive_native_handle().</span></div>
<div class="line"><a id="l00802" name="l00802"></a><span class="lineno">  802</span><span class="comment">   * @param on_done_func</span></div>
<div class="line"><a id="l00803" name="l00803"></a><span class="lineno">  803</span><span class="comment">   *        See async_receive_native_handle().</span></div>
<div class="line"><a id="l00804" name="l00804"></a><span class="lineno">  804</span><span class="comment">   * @return See async_receive_native_handle().</span></div>
<div class="line"><a id="l00805" name="l00805"></a><span class="lineno">  805</span><span class="comment">   */</span></div>
<div class="line"><a id="l00806" name="l00806"></a><span class="lineno">  806</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1transport_1_1Native__socket__stream.html#ab6df246711fd2ca98c10ed1235e0aa1c">async_receive_native_handle_fwd</a>(<a class="code hl_struct" href="structipc_1_1util_1_1Native__handle.html">Native_handle</a>* target_hndl,</div>
<div class="line"><a id="l00807" name="l00807"></a><span class="lineno">  807</span>                                       <span class="keyword">const</span> <a class="code hl_typedef" href="namespaceipc_1_1util.html#a6cb62ae434900f3a8915b33ec5d61a96">util::Blob_mutable</a>&amp; target_meta_blob,</div>
<div class="line"><a id="l00808" name="l00808"></a><span class="lineno">  808</span>                                       flow::async::Task_asio_err_sz&amp;&amp; on_done_func);</div>
<div class="line"><a id="l00809" name="l00809"></a><span class="lineno">  809</span><span class="comment"></span> </div>
<div class="line"><a id="l00810" name="l00810"></a><span class="lineno">  810</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00811" name="l00811"></a><span class="lineno">  811</span><span class="comment">   * Template-free version of async_receive_blob() as required by pImpl idiom.</span></div>
<div class="line"><a id="l00812" name="l00812"></a><span class="lineno">  812</span><span class="comment">   *</span></div>
<div class="line"><a id="l00813" name="l00813"></a><span class="lineno">  813</span><span class="comment">   * @param target_blob</span></div>
<div class="line"><a id="l00814" name="l00814"></a><span class="lineno">  814</span><span class="comment">   *        See async_receive_blob().</span></div>
<div class="line"><a id="l00815" name="l00815"></a><span class="lineno">  815</span><span class="comment">   * @param on_done_func</span></div>
<div class="line"><a id="l00816" name="l00816"></a><span class="lineno">  816</span><span class="comment">   *        See async_receive_blob().</span></div>
<div class="line"><a id="l00817" name="l00817"></a><span class="lineno">  817</span><span class="comment">   * @return See async_receive_blob().</span></div>
<div class="line"><a id="l00818" name="l00818"></a><span class="lineno">  818</span><span class="comment">   */</span></div>
<div class="line"><a id="l00819" name="l00819"></a><span class="lineno">  819</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1transport_1_1Native__socket__stream.html#a5a134afa6a1f07f956e13fc0835873ee">async_receive_blob_fwd</a>(<span class="keyword">const</span> <a class="code hl_typedef" href="namespaceipc_1_1util.html#a6cb62ae434900f3a8915b33ec5d61a96">util::Blob_mutable</a>&amp; target_blob,</div>
<div class="line"><a id="l00820" name="l00820"></a><span class="lineno">  820</span>                              flow::async::Task_asio_err_sz&amp;&amp; on_done_func);</div>
<div class="line"><a id="l00821" name="l00821"></a><span class="lineno">  821</span> </div>
<div class="line"><a id="l00822" name="l00822"></a><span class="lineno">  822</span>  <span class="comment">// Data.</span></div>
<div class="line"><a id="l00823" name="l00823"></a><span class="lineno">  823</span><span class="comment"></span> </div>
<div class="line"><a id="l00824" name="l00824"></a><span class="lineno">  824</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00825" name="l00825"></a><span class="lineno">  825</span><span class="comment">   * The true implementation of this class.  See also our class doc header; and impl() (in particular explaining</span></div>
<div class="line"><a id="l00826" name="l00826"></a><span class="lineno">  826</span><span class="comment">   * why this is `mutable`).</span></div>
<div class="line"><a id="l00827" name="l00827"></a><span class="lineno">  827</span><span class="comment">   *</span></div>
<div class="line"><a id="l00828" name="l00828"></a><span class="lineno">  828</span><span class="comment">   * Do not access directly but only via impl().</span></div>
<div class="line"><a id="l00829" name="l00829"></a><span class="lineno">  829</span><span class="comment">   */</span></div>
<div class="line"><a id="l00830" name="l00830"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1Native__socket__stream.html#abb4c0c38ff868a91ee3597e0bd237d34">  830</a></span>  <span class="keyword">mutable</span> <a class="code hl_typedef" href="classipc_1_1transport_1_1Native__socket__stream.html#ab93697ce64c2f2357d319ae2cdf7a1da">Impl_ptr</a> <a class="code hl_variable" href="classipc_1_1transport_1_1Native__socket__stream.html#abb4c0c38ff868a91ee3597e0bd237d34">m_impl</a>;</div>
<div class="line"><a id="l00831" name="l00831"></a><span class="lineno">  831</span>}; <span class="comment">// class Native_socket_stream</span></div>
<div class="line"><a id="l00832" name="l00832"></a><span class="lineno">  832</span> </div>
<div class="line"><a id="l00833" name="l00833"></a><span class="lineno">  833</span><span class="comment">// Free functions: in *_fwd.hpp.</span></div>
<div class="line"><a id="l00834" name="l00834"></a><span class="lineno">  834</span> </div>
<div class="line"><a id="l00835" name="l00835"></a><span class="lineno">  835</span><span class="comment">// Template implementations.</span></div>
<div class="line"><a id="l00836" name="l00836"></a><span class="lineno">  836</span> </div>
<div class="line"><a id="l00837" name="l00837"></a><span class="lineno">  837</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Task_err&gt;</div>
<div class="line"><a id="l00838" name="l00838"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1Native__socket__stream.html#ac3cd00ddd2e0502677630320708277a3">  838</a></span><span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1transport_1_1Native__socket__stream.html#ac3cd00ddd2e0502677630320708277a3">Native_socket_stream::async_end_sending</a>(Task_err&amp;&amp; on_done_func)</div>
<div class="line"><a id="l00839" name="l00839"></a><span class="lineno">  839</span>{</div>
<div class="line"><a id="l00840" name="l00840"></a><span class="lineno">  840</span>  <span class="keyword">using </span>flow::async::Task_asio_err;</div>
<div class="line"><a id="l00841" name="l00841"></a><span class="lineno">  841</span> </div>
<div class="line"><a id="l00842" name="l00842"></a><span class="lineno">  842</span>  <span class="comment">/* Perf note: In all cases, as of this writing, Impl would wrap the various handler parameterized args in</span></div>
<div class="line"><a id="l00843" name="l00843"></a><span class="lineno">  843</span><span class="comment">   * concrete Function&lt;&gt;s anyway for its own impl ease; so we change nothing by doing this higher up in the call stack</span></div>
<div class="line"><a id="l00844" name="l00844"></a><span class="lineno">  844</span><span class="comment">   * in this template and its siblings below. */</span></div>
<div class="line"><a id="l00845" name="l00845"></a><span class="lineno">  845</span> </div>
<div class="line"><a id="l00846" name="l00846"></a><span class="lineno">  846</span>  <span class="keywordflow">return</span> <a class="code hl_function" href="classipc_1_1transport_1_1Native__socket__stream.html#a949ab3296e29230518095d1f00f57a93">async_end_sending_fwd</a>(Task_asio_err(std::move(on_done_func)));</div>
<div class="line"><a id="l00847" name="l00847"></a><span class="lineno">  847</span>}</div>
<div class="line"><a id="l00848" name="l00848"></a><span class="lineno">  848</span> </div>
<div class="line"><a id="l00849" name="l00849"></a><span class="lineno">  849</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Task_err_sz&gt;</div>
<div class="line"><a id="l00850" name="l00850"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1Native__socket__stream.html#a266b52821557f2a4fa8f81058290dee2">  850</a></span><span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1transport_1_1Native__socket__stream.html#a266b52821557f2a4fa8f81058290dee2">Native_socket_stream::async_receive_native_handle</a>(<a class="code hl_struct" href="structipc_1_1util_1_1Native__handle.html">Native_handle</a>* target_hndl,</div>
<div class="line"><a id="l00851" name="l00851"></a><span class="lineno">  851</span>                                                       <span class="keyword">const</span> <a class="code hl_typedef" href="namespaceipc_1_1util.html#a6cb62ae434900f3a8915b33ec5d61a96">util::Blob_mutable</a>&amp; target_meta_blob,</div>
<div class="line"><a id="l00852" name="l00852"></a><span class="lineno">  852</span>                                                       Task_err_sz&amp;&amp; on_done_func)</div>
<div class="line"><a id="l00853" name="l00853"></a><span class="lineno">  853</span>{</div>
<div class="line"><a id="l00854" name="l00854"></a><span class="lineno">  854</span>  <span class="keyword">using </span>flow::async::Task_asio_err_sz;</div>
<div class="line"><a id="l00855" name="l00855"></a><span class="lineno">  855</span> </div>
<div class="line"><a id="l00856" name="l00856"></a><span class="lineno">  856</span>  <span class="keywordflow">return</span> <a class="code hl_function" href="classipc_1_1transport_1_1Native__socket__stream.html#ab6df246711fd2ca98c10ed1235e0aa1c">async_receive_native_handle_fwd</a>(target_hndl, target_meta_blob, Task_asio_err_sz(std::move(on_done_func)));</div>
<div class="line"><a id="l00857" name="l00857"></a><span class="lineno">  857</span>}</div>
<div class="line"><a id="l00858" name="l00858"></a><span class="lineno">  858</span> </div>
<div class="line"><a id="l00859" name="l00859"></a><span class="lineno">  859</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Task_err_sz&gt;</div>
<div class="line"><a id="l00860" name="l00860"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1Native__socket__stream.html#ac5572c8165e25f106f18d327c07d1c3f">  860</a></span><span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1transport_1_1Native__socket__stream.html#ac5572c8165e25f106f18d327c07d1c3f">Native_socket_stream::async_receive_blob</a>(<span class="keyword">const</span> <a class="code hl_typedef" href="namespaceipc_1_1util.html#a6cb62ae434900f3a8915b33ec5d61a96">util::Blob_mutable</a>&amp; target_blob, Task_err_sz&amp;&amp; on_done_func)</div>
<div class="line"><a id="l00861" name="l00861"></a><span class="lineno">  861</span>{</div>
<div class="line"><a id="l00862" name="l00862"></a><span class="lineno">  862</span>  <span class="keyword">using </span>flow::async::Task_asio_err_sz;</div>
<div class="line"><a id="l00863" name="l00863"></a><span class="lineno">  863</span> </div>
<div class="line"><a id="l00864" name="l00864"></a><span class="lineno">  864</span>  <span class="keywordflow">return</span> <a class="code hl_function" href="classipc_1_1transport_1_1Native__socket__stream.html#a5a134afa6a1f07f956e13fc0835873ee">async_receive_blob_fwd</a>(target_blob, Task_asio_err_sz(std::move(on_done_func)));</div>
<div class="line"><a id="l00865" name="l00865"></a><span class="lineno">  865</span>}</div>
<div class="line"><a id="l00866" name="l00866"></a><span class="lineno">  866</span> </div>
<div class="line"><a id="l00867" name="l00867"></a><span class="lineno">  867</span>} <span class="comment">// namespace ipc::transport</span></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Native__socket__stream_1_1Impl_html"><div class="ttname"><a href="classipc_1_1transport_1_1Native__socket__stream_1_1Impl.html">ipc::transport::Native_socket_stream::Impl</a></div><div class="ttdoc">Internal, non-movable pImpl implementation of Native_socket_stream class.</div><div class="ttdef"><b>Definition:</b> <a href="detail_2native__socket__stream__impl_8hpp_source.html#l00148">native_socket_stream_impl.hpp:151</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Native__socket__stream_html"><div class="ttname"><a href="classipc_1_1transport_1_1Native__socket__stream.html">ipc::transport::Native_socket_stream</a></div><div class="ttdoc">Implements both Native_handle_sender and Native_handle_receiver concepts by using a stream-oriented U...</div><div class="ttdef"><b>Definition:</b> <a href="native__socket__stream_8hpp_source.html#l00270">native_socket_stream.hpp:271</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Native__socket__stream_html_a0d0416ffe729877dad845e88c3609974"><div class="ttname"><a href="classipc_1_1transport_1_1Native__socket__stream.html#a0d0416ffe729877dad845e88c3609974">ipc::transport::Native_socket_stream::impl</a></div><div class="ttdeci">Impl_ptr &amp; impl() const</div><div class="ttdoc">Helper that simply returns m_impl while guaranteeing that m_impl is non-null upon return.</div><div class="ttdef"><b>Definition:</b> <a href="native__socket__stream_8cpp_source.html#l00041">native_socket_stream.cpp:41</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Native__socket__stream_html_a11409650b45a575743371169226aaf7c"><div class="ttname"><a href="classipc_1_1transport_1_1Native__socket__stream.html#a11409650b45a575743371169226aaf7c">ipc::transport::Native_socket_stream::Native_socket_stream</a></div><div class="ttdeci">Native_socket_stream(const Native_socket_stream &amp;)=delete</div><div class="ttdoc">Copy construction is disallowed.</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Native__socket__stream_html_a11715d6bc6844d1189ff694344bc343a"><div class="ttname"><a href="classipc_1_1transport_1_1Native__socket__stream.html#a11715d6bc6844d1189ff694344bc343a">ipc::transport::Native_socket_stream::operator=</a></div><div class="ttdeci">Native_socket_stream &amp; operator=(const Native_socket_stream &amp;)=delete</div><div class="ttdoc">Copy assignment is disallowed.</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Native__socket__stream_html_a127a462a4aaf6e5cf1e42bdd33f51693"><div class="ttname"><a href="classipc_1_1transport_1_1Native__socket__stream.html#a127a462a4aaf6e5cf1e42bdd33f51693">ipc::transport::Native_socket_stream::send_blob_max_size</a></div><div class="ttdeci">size_t send_blob_max_size() const</div><div class="ttdoc">Implements Blob_sender API per contract.</div><div class="ttdef"><b>Definition:</b> <a href="native__socket__stream_8cpp_source.html#l00104">native_socket_stream.cpp:104</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Native__socket__stream_html_a1b4ce3ddee39f21e752ec9114ac17bbd"><div class="ttname"><a href="classipc_1_1transport_1_1Native__socket__stream.html#a1b4ce3ddee39f21e752ec9114ac17bbd">ipc::transport::Native_socket_stream::idle_timer_run</a></div><div class="ttdeci">bool idle_timer_run(util::Fine_duration timeout=boost::chrono::seconds(5))</div><div class="ttdoc">Implements Native_handle_receiver, Blob_receiver API per contract.</div><div class="ttdef"><b>Definition:</b> <a href="native__socket__stream_8cpp_source.html#l00140">native_socket_stream.cpp:140</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Native__socket__stream_html_a1ff9e6811c0d662a6a960602be5926e0"><div class="ttname"><a href="classipc_1_1transport_1_1Native__socket__stream.html#a1ff9e6811c0d662a6a960602be5926e0">ipc::transport::Native_socket_stream::~Native_socket_stream</a></div><div class="ttdeci">~Native_socket_stream()</div><div class="ttdoc">Implements Native_handle_sender and Native_handle_receiver APIs at the same time, per their concept c...</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Native__socket__stream_html_a25d9c0e12a03a3b68f7f266c23466f71"><div class="ttname"><a href="classipc_1_1transport_1_1Native__socket__stream.html#a25d9c0e12a03a3b68f7f266c23466f71">ipc::transport::Native_socket_stream::nickname</a></div><div class="ttdeci">const std::string &amp; nickname() const</div><div class="ttdoc">Returns nickname, a brief string suitable for logging.</div><div class="ttdef"><b>Definition:</b> <a href="native__socket__stream_8cpp_source.html#l00084">native_socket_stream.cpp:84</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Native__socket__stream_html_a266b52821557f2a4fa8f81058290dee2"><div class="ttname"><a href="classipc_1_1transport_1_1Native__socket__stream.html#a266b52821557f2a4fa8f81058290dee2">ipc::transport::Native_socket_stream::async_receive_native_handle</a></div><div class="ttdeci">bool async_receive_native_handle(Native_handle *target_hndl, const util::Blob_mutable &amp;target_meta_blob, Task_err_sz &amp;&amp;on_done_func)</div><div class="ttdoc">Implements Native_handle_receiver API per contract.</div><div class="ttdef"><b>Definition:</b> <a href="native__socket__stream_8hpp_source.html#l00850">native_socket_stream.hpp:850</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Native__socket__stream_html_a415febd76ee222c81d59d2bcfa9c01bc"><div class="ttname"><a href="classipc_1_1transport_1_1Native__socket__stream.html#a415febd76ee222c81d59d2bcfa9c01bc">ipc::transport::Native_socket_stream::send_blob</a></div><div class="ttdeci">bool send_blob(const util::Blob_const &amp;blob, Error_code *err_code=0)</div><div class="ttdoc">Implements Blob_sender API per contract.</div><div class="ttdef"><b>Definition:</b> <a href="native__socket__stream_8cpp_source.html#l00115">native_socket_stream.cpp:115</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Native__socket__stream_html_a433d09587c6d854e59c12d4f483516fb"><div class="ttname"><a href="classipc_1_1transport_1_1Native__socket__stream.html#a433d09587c6d854e59c12d4f483516fb">ipc::transport::Native_socket_stream::Native_socket_stream</a></div><div class="ttdeci">Native_socket_stream(Native_socket_stream &amp;&amp;src)</div><div class="ttdoc">Move-constructs from src; src becomes as-if default-cted (therefore in NULL state).</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Native__socket__stream_html_a555df6a81654160285ea35b545cfd23d"><div class="ttname"><a href="classipc_1_1transport_1_1Native__socket__stream.html#a555df6a81654160285ea35b545cfd23d">ipc::transport::Native_socket_stream::send_native_handle</a></div><div class="ttdeci">bool send_native_handle(Native_handle hndl_or_null, const util::Blob_const &amp;meta_blob, Error_code *err_code=0)</div><div class="ttdoc">Implements Native_handle_sender API per contract.</div><div class="ttdef"><b>Definition:</b> <a href="native__socket__stream_8cpp_source.html#l00109">native_socket_stream.cpp:109</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Native__socket__stream_html_a59d4ec9f05762a8bc2db4b752d4fd5f4"><div class="ttname"><a href="classipc_1_1transport_1_1Native__socket__stream.html#a59d4ec9f05762a8bc2db4b752d4fd5f4">ipc::transport::Native_socket_stream::S_BLOB_UNDERFLOW_ALLOWED</a></div><div class="ttdeci">static constexpr bool S_BLOB_UNDERFLOW_ALLOWED</div><div class="ttdoc">Implements concept API; namely it is true: async_receive_blob() with smaller-than-receive_blob_max_si...</div><div class="ttdef"><b>Definition:</b> <a href="native__socket__stream_8hpp_source.html#l00303">native_socket_stream.hpp:303</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Native__socket__stream_html_a5a134afa6a1f07f956e13fc0835873ee"><div class="ttname"><a href="classipc_1_1transport_1_1Native__socket__stream.html#a5a134afa6a1f07f956e13fc0835873ee">ipc::transport::Native_socket_stream::async_receive_blob_fwd</a></div><div class="ttdeci">bool async_receive_blob_fwd(const util::Blob_mutable &amp;target_blob, flow::async::Task_asio_err_sz &amp;&amp;on_done_func)</div><div class="ttdoc">Template-free version of async_receive_blob() as required by pImpl idiom.</div><div class="ttdef"><b>Definition:</b> <a href="native__socket__stream_8cpp_source.html#l00166">native_socket_stream.cpp:166</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Native__socket__stream_html_a6271d2cc490f82197990c70be5d8747e"><div class="ttname"><a href="classipc_1_1transport_1_1Native__socket__stream.html#a6271d2cc490f82197990c70be5d8747e">ipc::transport::Native_socket_stream::S_RESOURCE_TYPE_ID</a></div><div class="ttdeci">static const Shared_name &amp; S_RESOURCE_TYPE_ID</div><div class="ttdoc">Implements concept API.</div><div class="ttdef"><b>Definition:</b> <a href="native__socket__stream_8hpp_source.html#l00283">native_socket_stream.hpp:283</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Native__socket__stream_html_a844b8245c9341da8006f979c6b005893"><div class="ttname"><a href="classipc_1_1transport_1_1Native__socket__stream.html#a844b8245c9341da8006f979c6b005893">ipc::transport::Native_socket_stream::send_meta_blob_max_size</a></div><div class="ttdeci">size_t send_meta_blob_max_size() const</div><div class="ttdoc">Implements Native_handle_sender API per contract.</div><div class="ttdef"><b>Definition:</b> <a href="native__socket__stream_8cpp_source.html#l00099">native_socket_stream.cpp:99</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Native__socket__stream_html_a859615800ba1e0546c8e5cb8a6796e41"><div class="ttname"><a href="classipc_1_1transport_1_1Native__socket__stream.html#a859615800ba1e0546c8e5cb8a6796e41">ipc::transport::Native_socket_stream::S_META_BLOB_UNDERFLOW_ALLOWED</a></div><div class="ttdeci">static constexpr bool S_META_BLOB_UNDERFLOW_ALLOWED</div><div class="ttdoc">Implements concept API; namely it is true: async_receive_native_handle() with smaller-than-receive_me...</div><div class="ttdef"><b>Definition:</b> <a href="native__socket__stream_8hpp_source.html#l00293">native_socket_stream.hpp:293</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Native__socket__stream_html_a89d591db714e83dcb55a52738fed1ebb"><div class="ttname"><a href="classipc_1_1transport_1_1Native__socket__stream.html#a89d591db714e83dcb55a52738fed1ebb">ipc::transport::Native_socket_stream::sync_connect</a></div><div class="ttdeci">bool sync_connect(const Shared_name &amp;absolute_name, Error_code *err_code=0)</div><div class="ttdoc">To be invoked in NULL state only, it synchronously and non-blockingly attempts to connect to an oppos...</div><div class="ttdef"><b>Definition:</b> <a href="native__socket__stream_8cpp_source.html#l00089">native_socket_stream.cpp:89</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Native__socket__stream_html_a949ab3296e29230518095d1f00f57a93"><div class="ttname"><a href="classipc_1_1transport_1_1Native__socket__stream.html#a949ab3296e29230518095d1f00f57a93">ipc::transport::Native_socket_stream::async_end_sending_fwd</a></div><div class="ttdeci">bool async_end_sending_fwd(flow::async::Task_asio_err &amp;&amp;on_done_func)</div><div class="ttdoc">Template-free version of async_end_sending() as required by pImpl idiom.</div><div class="ttdef"><b>Definition:</b> <a href="native__socket__stream_8cpp_source.html#l00154">native_socket_stream.cpp:154</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Native__socket__stream_html_aa5e699d5eead4220bf8b5604f629a970"><div class="ttname"><a href="classipc_1_1transport_1_1Native__socket__stream.html#aa5e699d5eead4220bf8b5604f629a970">ipc::transport::Native_socket_stream::auto_ping</a></div><div class="ttdeci">bool auto_ping(util::Fine_duration period=boost::chrono::seconds(2))</div><div class="ttdoc">Implements Native_handle_sender, Blob_sender API per contract.</div><div class="ttdef"><b>Definition:</b> <a href="native__socket__stream_8cpp_source.html#l00125">native_socket_stream.cpp:125</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Native__socket__stream_html_aae823547a7ad0b9fdc691eb40c94d7da"><div class="ttname"><a href="classipc_1_1transport_1_1Native__socket__stream.html#aae823547a7ad0b9fdc691eb40c94d7da">ipc::transport::Native_socket_stream::Native_socket_stream</a></div><div class="ttdeci">Native_socket_stream()</div><div class="ttdoc">Default ctor (object is in NULL state).</div><div class="ttdef"><b>Definition:</b> <a href="native__socket__stream_8cpp_source.html#l00055">native_socket_stream.cpp:55</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Native__socket__stream_html_ab6df246711fd2ca98c10ed1235e0aa1c"><div class="ttname"><a href="classipc_1_1transport_1_1Native__socket__stream.html#ab6df246711fd2ca98c10ed1235e0aa1c">ipc::transport::Native_socket_stream::async_receive_native_handle_fwd</a></div><div class="ttdeci">bool async_receive_native_handle_fwd(Native_handle *target_hndl, const util::Blob_mutable &amp;target_meta_blob, flow::async::Task_asio_err_sz &amp;&amp;on_done_func)</div><div class="ttdoc">Template-free version of async_receive_native_handle() as required by pImpl idiom.</div><div class="ttdef"><b>Definition:</b> <a href="native__socket__stream_8cpp_source.html#l00159">native_socket_stream.cpp:159</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Native__socket__stream_html_ab93697ce64c2f2357d319ae2cdf7a1da"><div class="ttname"><a href="classipc_1_1transport_1_1Native__socket__stream.html#ab93697ce64c2f2357d319ae2cdf7a1da">ipc::transport::Native_socket_stream::Impl_ptr</a></div><div class="ttdeci">std::experimental::propagate_const&lt; boost::movelib::unique_ptr&lt; Impl &gt; &gt; Impl_ptr</div><div class="ttdoc">Short-hand for const-respecting wrapper around Native_socket_stream::Impl for the pImpl idiom.</div><div class="ttdef"><b>Definition:</b> <a href="native__socket__stream_8hpp_source.html#l00747">native_socket_stream.hpp:747</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Native__socket__stream_html_abb4c0c38ff868a91ee3597e0bd237d34"><div class="ttname"><a href="classipc_1_1transport_1_1Native__socket__stream.html#abb4c0c38ff868a91ee3597e0bd237d34">ipc::transport::Native_socket_stream::m_impl</a></div><div class="ttdeci">Impl_ptr m_impl</div><div class="ttdoc">The true implementation of this class.</div><div class="ttdef"><b>Definition:</b> <a href="native__socket__stream_8hpp_source.html#l00830">native_socket_stream.hpp:830</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Native__socket__stream_html_ac3cd00ddd2e0502677630320708277a3"><div class="ttname"><a href="classipc_1_1transport_1_1Native__socket__stream.html#ac3cd00ddd2e0502677630320708277a3">ipc::transport::Native_socket_stream::async_end_sending</a></div><div class="ttdeci">bool async_end_sending(Task_err &amp;&amp;on_done_func)</div><div class="ttdoc">Implements Native_handle_sender, Blob_sender API per contract.</div><div class="ttdef"><b>Definition:</b> <a href="native__socket__stream_8hpp_source.html#l00838">native_socket_stream.hpp:838</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Native__socket__stream_html_ac5572c8165e25f106f18d327c07d1c3f"><div class="ttname"><a href="classipc_1_1transport_1_1Native__socket__stream.html#ac5572c8165e25f106f18d327c07d1c3f">ipc::transport::Native_socket_stream::async_receive_blob</a></div><div class="ttdeci">bool async_receive_blob(const util::Blob_mutable &amp;target_blob, Task_err_sz &amp;&amp;on_done_func)</div><div class="ttdoc">Implements Blob_receiver API per contract.</div><div class="ttdef"><b>Definition:</b> <a href="native__socket__stream_8hpp_source.html#l00860">native_socket_stream.hpp:860</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Native__socket__stream_html_ac6108711cc8b33c3b7ef0491ba78e2f6"><div class="ttname"><a href="classipc_1_1transport_1_1Native__socket__stream.html#ac6108711cc8b33c3b7ef0491ba78e2f6">ipc::transport::Native_socket_stream::operator&lt;&lt;</a></div><div class="ttdeci">friend std::ostream &amp; operator&lt;&lt;(std::ostream &amp;os, const Native_socket_stream &amp;val)</div><div class="ttdoc">Friend of Native_socket_stream.</div><div class="ttdef"><b>Definition:</b> <a href="native__socket__stream_8cpp_source.html#l00147">native_socket_stream.cpp:147</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Native__socket__stream_html_ac7659af6812efca67c410af286f0cb34"><div class="ttname"><a href="classipc_1_1transport_1_1Native__socket__stream.html#ac7659af6812efca67c410af286f0cb34">ipc::transport::Native_socket_stream::receive_meta_blob_max_size</a></div><div class="ttdeci">size_t receive_meta_blob_max_size() const</div><div class="ttdoc">Implements Native_handle_receiver API per contract.</div><div class="ttdef"><b>Definition:</b> <a href="native__socket__stream_8cpp_source.html#l00130">native_socket_stream.cpp:130</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Native__socket__stream_html_ace134e4a6e4918212f256b60c3ed77e4"><div class="ttname"><a href="classipc_1_1transport_1_1Native__socket__stream.html#ace134e4a6e4918212f256b60c3ed77e4">ipc::transport::Native_socket_stream::end_sending</a></div><div class="ttdeci">bool end_sending()</div><div class="ttdoc">Implements Native_handle_sender, Blob_sender API per contract.</div><div class="ttdef"><b>Definition:</b> <a href="native__socket__stream_8cpp_source.html#l00120">native_socket_stream.cpp:120</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Native__socket__stream_html_adb667160fd0ab3951d93d219d7bdc3be"><div class="ttname"><a href="classipc_1_1transport_1_1Native__socket__stream.html#adb667160fd0ab3951d93d219d7bdc3be">ipc::transport::Native_socket_stream::receive_blob_max_size</a></div><div class="ttdeci">size_t receive_blob_max_size() const</div><div class="ttdoc">Implements Blob_receiver API per contract.</div><div class="ttdef"><b>Definition:</b> <a href="native__socket__stream_8cpp_source.html#l00135">native_socket_stream.cpp:135</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Native__socket__stream_html_af63671c0e30d39d3460331c4dd3742b2"><div class="ttname"><a href="classipc_1_1transport_1_1Native__socket__stream.html#af63671c0e30d39d3460331c4dd3742b2">ipc::transport::Native_socket_stream::remote_peer_process_credentials</a></div><div class="ttdeci">util::Process_credentials remote_peer_process_credentials(Error_code *err_code=0) const</div><div class="ttdoc">OS-reported process credential (PID, etc.) info about the other connected peer's process,...</div><div class="ttdef"><b>Definition:</b> <a href="native__socket__stream_8cpp_source.html#l00094">native_socket_stream.cpp:94</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Native__socket__stream_html_afa23616d048eef3649bd20a2385af4c5"><div class="ttname"><a href="classipc_1_1transport_1_1Native__socket__stream.html#afa23616d048eef3649bd20a2385af4c5">ipc::transport::Native_socket_stream::operator=</a></div><div class="ttdeci">Native_socket_stream &amp; operator=(Native_socket_stream &amp;&amp;src)</div><div class="ttdoc">Move-assigns from src; *this acts as if destructed; src becomes as-if default-cted (therefore in NULL...</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Null__peer_html"><div class="ttname"><a href="classipc_1_1transport_1_1Null__peer.html">ipc::transport::Null_peer</a></div><div class="ttdoc">Dummy type for use as a template param to Channel when either the blobs pipe or handles pipe is disab...</div><div class="ttdef"><b>Definition:</b> <a href="ipc__core_2src_2ipc_2transport_2channel_8hpp_source.html#l00999">channel.hpp:1000</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_html"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream.html">ipc::transport::sync_io::Native_socket_stream</a></div><div class="ttdoc">Implements both sync_io::Native_handle_sender and sync_io::Native_handle_receiver concepts by using a...</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2native__socket__stream_8hpp_source.html#l00150">native_socket_stream.hpp:151</a></div></div>
<div class="ttc" id="aclassipc_1_1util_1_1Process__credentials_html"><div class="ttname"><a href="classipc_1_1util_1_1Process__credentials.html">ipc::util::Process_credentials</a></div><div class="ttdoc">A process's credentials (PID, UID, GID as of this writing).</div><div class="ttdef"><b>Definition:</b> <a href="process__credentials_8hpp_source.html#l00038">process_credentials.hpp:39</a></div></div>
<div class="ttc" id="aclassipc_1_1util_1_1Shared__name_html"><div class="ttname"><a href="classipc_1_1util_1_1Shared__name.html">ipc::util::Shared_name</a></div><div class="ttdoc">String-wrapping abstraction representing a name uniquely distinguishing a kernel-persistent entity fr...</div><div class="ttdef"><b>Definition:</b> <a href="shared__name_8hpp_source.html#l00241">shared_name.hpp:242</a></div></div>
<div class="ttc" id="anamespaceipc_1_1transport_html"><div class="ttname"><a href="namespaceipc_1_1transport.html">ipc::transport</a></div><div class="ttdoc">Flow-IPC module providing transmission of structured messages and/or low-level blobs (and more) betwe...</div><div class="ttdef"><b>Definition:</b> <a href="asio__local__stream__socket_8cpp_source.html#l00031">asio_local_stream_socket.cpp:32</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_a6cb62ae434900f3a8915b33ec5d61a96"><div class="ttname"><a href="namespaceipc_1_1util.html#a6cb62ae434900f3a8915b33ec5d61a96">ipc::util::Blob_mutable</a></div><div class="ttdeci">boost::asio::mutable_buffer Blob_mutable</div><div class="ttdoc">Short-hand for an mutable blob somewhere in memory, stored as exactly a void* and a size_t.</div><div class="ttdef"><b>Definition:</b> <a href="util__fwd_8hpp_source.html#l00140">util_fwd.hpp:140</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_ac66141280c3b7295a86b65209f31cc58"><div class="ttname"><a href="namespaceipc_1_1util.html#ac66141280c3b7295a86b65209f31cc58">ipc::util::Fine_duration</a></div><div class="ttdeci">flow::Fine_duration Fine_duration</div><div class="ttdoc">Short-hand for Flow's Fine_duration.</div><div class="ttdef"><b>Definition:</b> <a href="util__fwd_8hpp_source.html#l00117">util_fwd.hpp:117</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_ae0be7edba7e30ffa3f8b742af621f2ab"><div class="ttname"><a href="namespaceipc_1_1util.html#ae0be7edba7e30ffa3f8b742af621f2ab">ipc::util::Blob_const</a></div><div class="ttdeci">boost::asio::const_buffer Blob_const</div><div class="ttdoc">Short-hand for an immutable blob somewhere in memory, stored as exactly a void const * and a size_t.</div><div class="ttdef"><b>Definition:</b> <a href="util__fwd_8hpp_source.html#l00134">util_fwd.hpp:134</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_ae6ac47812a90d1287c61e0b7de7bc4f5"><div class="ttname"><a href="namespaceipc_1_1util.html#ae6ac47812a90d1287c61e0b7de7bc4f5">ipc::util::String_view</a></div><div class="ttdeci">flow::util::String_view String_view</div><div class="ttdoc">Short-hand for Flow's String_view.</div><div class="ttdef"><b>Definition:</b> <a href="util__fwd_8hpp_source.html#l00115">util_fwd.hpp:115</a></div></div>
<div class="ttc" id="anamespaceipc_html_aa3192e586cc45d3e7c22463bf2760f89"><div class="ttname"><a href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">ipc::Error_code</a></div><div class="ttdeci">flow::Error_code Error_code</div><div class="ttdoc">Short-hand for flow::Error_code which is very common.</div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00298">common.hpp:298</a></div></div>
<div class="ttc" id="anative__handle_8hpp_html"><div class="ttname"><a href="native__handle_8hpp.html">native_handle.hpp</a></div></div>
<div class="ttc" id="aprocess__credentials_8hpp_html"><div class="ttname"><a href="process__credentials_8hpp.html">process_credentials.hpp</a></div></div>
<div class="ttc" id="ashared__name__fwd_8hpp_html"><div class="ttname"><a href="shared__name__fwd_8hpp.html">shared_name_fwd.hpp</a></div></div>
<div class="ttc" id="astructipc_1_1util_1_1Native__handle_html"><div class="ttname"><a href="structipc_1_1util_1_1Native__handle.html">ipc::util::Native_handle</a></div><div class="ttdoc">A monolayer-thin wrapper around a native handle, a/k/a descriptor a/k/a FD.</div><div class="ttdef"><b>Definition:</b> <a href="native__handle_8hpp_source.html#l00062">native_handle.hpp:63</a></div></div>
<div class="ttc" id="atransport__fwd_8hpp_html"><div class="ttname"><a href="transport__fwd_8hpp.html">transport_fwd.hpp</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu May 2 2024 23:56:38 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
